uniformJumpFvPatchField.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 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::uniformJumpFvPatchField
26 
27 Group
28  grpCoupledBoundaryConditions
29 
30 Description
31  This boundary condition provides a jump condition, using the \c cyclic
32  condition as a base. The jump is specified as a time-varying uniform
33  value across the patch.
34 
35  \heading Patch usage
36 
37  \table
38  Property | Description | Required | Default value
39  patchType | underlying patch type should be \c cyclic| yes |
40  jumpTable | jump value | yes |
41  \endtable
42 
43  Example of the boundary condition specification:
44  \verbatim
45  myPatch
46  {
47  type uniformJump;
48  patchType cyclic;
49  jumpTable constant 10;
50  }
51  \endverbatim
52 
53  The above example shows the use of a fixed jump of '10'.
54 
55 Note
56  The uniformValue entry is a DataEntry type, able to describe time
57  varying functions. The example above gives the usage for supplying a
58  constant value.
59 
60  The underlying \c patchType should be set to \c cyclic
61 
62 SeeAlso
63  Foam::fixedJumpFvPatchField
64 
65 SourceFiles
66  uniformJumpFvPatchField.C
67 
68 \*---------------------------------------------------------------------------*/
69 
70 #ifndef uniformJumpFvPatchField_H
71 #define uniformJumpFvPatchField_H
72 
73 #include "fixedJumpFvPatchField.H"
74 #include "DataEntry.H"
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 namespace Foam
79 {
80 
81 /*---------------------------------------------------------------------------*\
82  Class uniformJumpFvPatchField Declaration
83 \*---------------------------------------------------------------------------*/
84 
85 template<class Type>
86 class uniformJumpFvPatchField
87 :
88  public fixedJumpFvPatchField<Type>
89 {
90 
91 protected:
92 
93  // Protected data
94 
95  //- "jump" table
96  autoPtr<DataEntry<Type> > jumpTable_;
97 
98 
99 public:
101  //- Runtime type information
102  TypeName("uniformJump");
103 
104  // Constructors
105 
106  //- Construct from patch and internal field
108  (
109  const fvPatch&,
111  );
112 
113  //- Construct from patch, internal field and dictionary
115  (
116  const fvPatch&,
118  const dictionary&
119  );
120 
121  //- Construct by mapping given uniformJumpFvPatchField onto a
122  // new patch
124  (
126  const fvPatch&,
128  const fvPatchFieldMapper&
129  );
130 
131  //- Construct as copy
133  (
135  );
136 
137  //- Construct and return a clone
138  virtual tmp<fvPatchField<Type> > clone() const
139  {
140  return tmp<fvPatchField<Type> >
141  (
143  );
144  }
145 
146  //- Construct as copy setting internal field reference
148  (
151  );
153  //- Construct and return a clone setting internal field reference
154  virtual tmp<fvPatchField<Type> > clone
155  (
157  ) const
158  {
159  return tmp<fvPatchField<Type> >
160  (
161  new uniformJumpFvPatchField<Type>(*this, iF)
162  );
163  }
164 
165 
166  // Member functions
167 
168  //- Update the coefficients
169  virtual void updateCoeffs();
170 
171  //- Write
172  virtual void write(Ostream&) const;
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #ifdef NoRepository
183 # include "uniformJumpFvPatchField.C"
184 #endif
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 #endif
189 
190 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual void updateCoeffs()
Update the coefficients.
autoPtr< DataEntry< Type > > jumpTable_
"jump" table
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
TypeName("uniformJump")
Runtime type information.
uniformJumpFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a jump condition, using the cyclic condition as a base...
virtual void write(Ostream &) const
Write.
A class for managing temporary objects.
Definition: PtrList.H:118