fixedJumpAMIFvPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2012-2016 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 Group
28  grpCoupledBoundaryConditions
29 
30 Description
31  This boundary condition provides a jump condition, across non-conformal
32  cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
33 
34  The jump is specified as a fixed value field, applied as an offset to the
35  'owner' patch.
36 
37 Usage
38  \table
39  Property | Description | Required | Default value
40  patchType | underlying patch type should be \c cyclic| yes |
41  jump | current jump value | yes |
42  \endtable
43 
44  Example of the boundary condition specification:
45  \verbatim
46  <patchName>
47  {
48  type fixedJumpAMI;
49  patchType cyclic;
50  jump uniform 10;
51  }
52  \endverbatim
53 
54  The above example shows the use of a fixed jump of '10'.
55 
56 Note
57  The underlying \c patchType should be set to \c cyclicAMI
58 
59 See also
60  Foam::jumpCyclicAMIFvPatchField
61 
62 SourceFiles
63  fixedJumpAMIFvPatchField.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef fixedJumpAMIFvPatchField_H
68 #define fixedJumpAMIFvPatchField_H
69 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 namespace Foam
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class fixedJumpAMIFvPatchField Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 template<class Type>
82 class fixedJumpAMIFvPatchField
83 :
84  public jumpCyclicAMIFvPatchField<Type>
85 {
86 
87 protected:
88 
89  // Protected data
90 
91  //- "jump" field
92  Field<Type> jump_;
93 
94 
95 public:
96 
97  //- Runtime type information
98  TypeName("fixedJumpAMI");
99 
100 
101  // Constructors
102 
103  //- Construct from patch and internal field
105  (
106  const fvPatch&,
108  );
109 
110  //- Construct from patch, internal field and dictionary
112  (
113  const fvPatch&,
115  const dictionary&
116  );
117 
118  //- Construct by mapping given fixedJumpAMIFvPatchField onto a
119  // new patch
121  (
123  const fvPatch&,
125  const fvPatchFieldMapper&
126  );
127 
128  //- Construct as copy
130  (
132  );
133 
134  //- Construct and return a clone
135  virtual tmp<fvPatchField<Type>> clone() const
136  {
137  return tmp<fvPatchField<Type>>
138  (
140  );
141  }
142 
143  //- Construct as copy setting internal field reference
145  (
148  );
150  //- Construct and return a clone setting internal field reference
152  (
154  ) const
155  {
156  return tmp<fvPatchField<Type>>
157  (
158  new fixedJumpAMIFvPatchField<Type>(*this, iF)
159  );
160  }
161 
162 
163  // Member functions
164 
165  // Access
167  //- Return the "jump" across the patch
168  virtual tmp<Field<Type>> jump() const;
169 
170 
171  // Mapping functions
172 
173  //- Map (and resize as needed) from self given a mapping object
174  virtual void autoMap(const fvPatchFieldMapper&);
175 
176  //- Reverse map the given fvPatchField onto this fvPatchField
177  virtual void rmap(const fvPatchField<Type>&, const labelList&);
178 
179 
180  //- Write
181  virtual void write(Ostream&) const;
182 };
183 
184 
185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
186 
187 } // End namespace Foam
188 
189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
190 
191 #ifdef NoRepository
192  #include "fixedJumpAMIFvPatchField.C"
193 #endif
194 
195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196 
197 #endif
198 
199 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
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 tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
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.
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.