mappedFixedInternalValueFvPatchField.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-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::mappedFixedInternalValueFvPatchField
26 
27 Description
28  This boundary condition maps the boundary and internal values of a
29  neighbour patch field to the boundary and internal values of *this.
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  fieldName | name of field to be mapped | no | this field name
35  setAverage | flag to activate setting of average value | yes |
36  average | average value to apply if \c setAverage = yes | yes |
37  \endtable
38 
39  \verbatim
40  <patchName>
41  {
42  type mappedFixedInternalValue;
43  fieldName T;
44  setAverage no;
45  average 0;
46  value uniform 0;
47  }
48  \endverbatim
49 
50 Note
51  This boundary condition can only be applied to patches that are of
52  the \c mappedPolyPatch type.
53 
54 See also
55  Foam::mappedPatchBase
56  Foam::mappedPolyPatch
57  Foam::mappedFvPatch
58  Foam::mappedFixedValueFvPatchField
59 
60 SourceFiles
61  mappedFixedInternalValueFvPatchField.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef mappedFixedInternalValueFvPatchField_H
66 #define mappedFixedInternalValueFvPatchField_H
67 
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 
75 /*---------------------------------------------------------------------------*\
76  Class mappedFixedInternalValueFvPatchField Declaration
77 \*---------------------------------------------------------------------------*/
78 
79 template<class Type>
80 class mappedFixedInternalValueFvPatchField
81 :
82  public mappedFixedValueFvPatchField<Type>
83 {
84 
85 public:
86 
87  //- Runtime type information
88  TypeName("mappedFixedInternalValue");
89 
90 
91  // Constructors
92 
93  //- Construct from patch and internal field
95  (
96  const fvPatch&,
97  const DimensionedField<Type, volMesh>&
98  );
99 
100  //- Construct from patch, internal field and dictionary
102  (
103  const fvPatch&,
105  const dictionary&
106  );
107 
108  //- Construct by mapping given
109  // mappedFixedInternalValueFvPatchField onto a new patch
111  (
113  const fvPatch&,
115  const fvPatchFieldMapper&
116  );
117 
118  //- Construct as copy
120  (
122  );
123 
124  //- Construct and return a clone
125  virtual tmp<fvPatchField<Type>> clone() const
126  {
127  return tmp<fvPatchField<Type>>
128  (
130  );
131  }
132 
133  //- Construct as copy setting internal field reference
135  (
138  );
139 
140  //- Construct and return a clone setting internal field reference
142  (
144  ) const
145  {
146  return tmp<fvPatchField<Type>>
147  (
149  );
150  }
151 
152 
153  // Member functions
154 
155  // Evaluation functions
156 
157  //- Update the coefficients associated with the patch field
158  virtual void updateCoeffs();
159 
160  //- Write
161  virtual void write(Ostream&) const;
162 };
163 
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 } // End namespace Foam
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 #ifdef NoRepository
173 #endif
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
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
TypeName("mappedFixedInternalValue")
Runtime type information.
Foam::fvPatchFieldMapper.
mappedFixedInternalValueFvPatchField(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
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
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
This boundary condition maps the boundary and internal values of a neighbour patch field to the bound...
Namespace for OpenFOAM.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.