uniformJumpAMIFvPatchField.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-2018 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::uniformJumpAMIFvPatchField
26 
27 Description
28  This boundary condition provides a jump condition, using the \c cyclicAMI
29  condition as a base. The jump is specified as a time-varying uniform
30  value across the patch.
31 
32 Usage
33  \table
34  Property | Description | Required | Default value
35  patchType | underlying patch type should be \c cyclicAMI| yes |
36  jumpTable | jump value | yes |
37  \endtable
38 
39  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type uniformJumpAMI;
44  patchType cyclicAMI;
45  jumpTable constant 10;
46  }
47  \endverbatim
48 
49  The above example shows the use of a fixed jump of '10'.
50 
51 Note
52  The uniformValue entry is a Function1 type, able to describe time
53  varying functions. The example above gives the usage for supplying a
54  constant value.
55 
56  The underlying \c patchType should be set to \c cyclic
57 
58 See also
59  Foam::jumpCyclicAMIFvPatchField
60  Foam::Function1Types
61 
62 SourceFiles
63  uniformJumpAMIFvPatchField.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef uniformJumpAMIFvPatchField_H
68 #define uniformJumpAMIFvPatchField_H
69 
71 #include "Function1.H"
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 namespace Foam
76 {
77 
78 /*---------------------------------------------------------------------------*\
79  Class uniformJumpAMIFvPatchField Declaration
80 \*---------------------------------------------------------------------------*/
81 
82 template<class Type>
83 class uniformJumpAMIFvPatchField
84 :
85  public fixedJumpAMIFvPatchField<Type>
86 {
87 
88 protected:
89 
90  // Protected data
91 
92  //- "jump" table
93  autoPtr<Function1<Type>> jumpTable_;
94 
95 
96 public:
97 
98  //- Runtime type information
99  TypeName("uniformJumpAMI");
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 uniformJumpAMIFvPatchField 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 uniformJumpAMIFvPatchField<Type>(*this, iF)
159  );
160  }
161 
162 
163  // Member functions
164 
165  //- Update the coefficients
166  virtual void updateCoeffs();
167 
168  //- Write
169  virtual void write(Ostream&) const;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #ifdef NoRepository
181 #endif
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #endif
186 
187 // ************************************************************************* //
virtual void write(Ostream &) const
Write.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
autoPtr< Function1< Type > > jumpTable_
"jump" table
This boundary condition provides a jump condition, using the cyclicAMI condition as a base...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual void updateCoeffs()
Update the coefficients.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
uniformJumpAMIFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
TypeName("uniformJumpAMI")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.