fixedJumpFvPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::fixedJumpFvPatchField
26 
27 Description
28  This boundary condition provides a jump condition, using the \c cyclic
29  condition as a base.
30 
31  The jump is specified as a fixed value field, applied as an offset to the
32  'owner' patch.
33 
34 Usage
35  \table
36  Property | Description | Required | Default value
37  patchType | underlying patch type should be \c cyclic| yes |
38  jump | current jump value | yes |
39  \endtable
40 
41  Example of the boundary condition specification:
42  \verbatim
43  <patchName>
44  {
45  type fixedJump;
46  patchType cyclic;
47  jump uniform 10;
48  }
49  \endverbatim
50 
51  The above example shows the use of a fixed jump of '10'.
52 
53 Note
54  The underlying \c patchType should be set to \c cyclic
55 
56 See also
57  Foam::jumpCyclicFvPatchField
58 
59 SourceFiles
60  fixedJumpFvPatchField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef fixedJumpFvPatchField_H
65 #define fixedJumpFvPatchField_H
66 
67 #include "jumpCyclicFvPatchField.H"
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class fixedJumpFvPatchField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 template<class Type>
79 class fixedJumpFvPatchField
80 :
81  public jumpCyclicFvPatchField<Type>
82 {
83 
84 protected:
85 
86  // Protected data
87 
88  //- "jump" field
89  Field<Type> jump_;
90 
91 
92 public:
93 
94  //- Runtime type information
95  TypeName("fixedJump");
96 
97  // Constructors
98 
99  //- Construct from patch and internal field
101  (
102  const fvPatch&,
104  );
105 
106  //- Construct from patch, internal field and dictionary
108  (
109  const fvPatch&,
111  const dictionary&
112  );
113 
114  //- Construct by mapping given fixedJumpFvPatchField onto a
115  // new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Copy constructor
126  (
128  );
129 
130  //- Construct and return a clone
131  virtual tmp<fvPatchField<Type>> clone() const
132  {
133  return tmp<fvPatchField<Type>>
134  (
135  new fixedJumpFvPatchField<Type>(*this)
136  );
137  }
138 
139  //- Copy constructor setting internal field reference
141  (
144  );
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
152  return tmp<fvPatchField<Type>>
153  (
154  new fixedJumpFvPatchField<Type>(*this, iF)
155  );
156  }
157 
158 
159  // Member Functions
160 
161  // Access
163  //- Return the "jump" across the patch
164  virtual tmp<Field<Type>> jump() const;
165 
166 
167  // Mapping functions
168 
169  //- Map (and resize as needed) from self given a mapping object
170  // Used to update fields following mesh topology change
171  virtual void autoMap(const fvPatchFieldMapper&);
172 
173  //- Reverse map the given fvPatchField onto this fvPatchField
174  // Used to reconstruct fields
175  virtual void rmap(const fvPatchField<Type>&, const labelList&);
176 
177 
178  //- Write
179  virtual void write(Ostream&) const;
180 };
181 
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 } // End namespace Foam
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 #ifdef NoRepository
190  #include "fixedJumpFvPatchField.C"
191 #endif
192 
193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
194 
195 #endif
196 
197 // ************************************************************************* //
TypeName("fixedJump")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Field< Type > jump_
"jump" field
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
fixedJumpFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
virtual void write(Ostream &) const
Write.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
This boundary condition provides a jump condition, using the cyclic condition as a base...
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< Field< Type > > jump() const
Return the "jump" across the patch.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.