fixedJumpAMIFvPatchField.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) 2012-2022 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::fixedJumpAMIFvPatchField
26 
27 Description
28  This boundary condition provides a jump condition, across non-conformal
29  cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
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 fixedJumpAMI;
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 cyclicAMI
55 
56 See also
57  Foam::jumpCyclicAMIFvPatchField
58 
59 SourceFiles
60  fixedJumpAMIFvPatchField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef fixedJumpAMIFvPatchField_H
65 #define fixedJumpAMIFvPatchField_H
66 
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class fixedJumpAMIFvPatchField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 template<class Type>
79 class fixedJumpAMIFvPatchField
80 :
81  public jumpCyclicAMIFvPatchField<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("fixedJumpAMI");
96 
97 
98  // Constructors
99 
100  //- Construct from patch and internal field
102  (
103  const fvPatch&,
105  );
106 
107  //- Construct from patch, internal field and dictionary
109  (
110  const fvPatch&,
112  const dictionary&
113  );
114 
115  //- Construct by mapping given fixedJumpAMIFvPatchField onto a
116  // new patch
118  (
120  const fvPatch&,
122  const fvPatchFieldMapper&
123  );
124 
125  //- Disallow copy without setting internal field reference
127  (
129  ) = delete;
130 
131  //- Copy constructor setting internal field reference
133  (
136  );
137 
138  //- Construct and return a clone setting internal field reference
140  (
142  ) const
143  {
144  return tmp<fvPatchField<Type>>
145  (
146  new fixedJumpAMIFvPatchField<Type>(*this, iF)
147  );
148  }
149 
150 
151  // Member Functions
152 
153  // Access
155  //- Return the "jump" across the patch
156  virtual tmp<Field<Type>> jump() const;
157 
158 
159  // Mapping functions
160 
161  //- Map (and resize as needed) from self given a mapping object
162  virtual void autoMap(const fvPatchFieldMapper&);
163 
164  //- Reverse map the given fvPatchField onto this fvPatchField
165  virtual void rmap(const fvPatchField<Type>&, const labelList&);
166 
167  //- Reset the fvPatchField to the given fvPatchField
168  // Used for mesh to mesh mapping
169  virtual void reset(const fvPatchField<Type>&);
170 
171 
172  //- Write
173  virtual void write(Ostream&) const;
174 };
175 
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 } // End namespace Foam
180 
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 
183 #ifdef NoRepository
184  #include "fixedJumpAMIFvPatchField.C"
185 #endif
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 #endif
190 
191 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Foam::fvPatchFieldMapper.
TypeName("fixedJumpAMI")
Runtime type information.
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
virtual tmp< Field< Type > > jump() const
Return the "jump" across the patch.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
fixedJumpAMIFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
virtual void write(Ostream &) const
Write.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Namespace for OpenFOAM.