mappedFixedPushedInternalValueFvPatchField.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::mappedFixedPushedInternalValueFvPatchField
26 
27 Description
28  This boundary condition maps the boundary values of a neighbour patch
29  field to the boundary and internal cell 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  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type mappedFixedPushedInternalValue;
44  fieldName T;
45  setAverage no;
46  average 0;
47  value uniform 0;
48  }
49  \endverbatim
50 
51 Note
52  This boundary condition can only be applied to patches that are of
53  the \c mappedPolyPatch type.
54 
55 See also
56  Foam::mappedPatchBase
57  Foam::mappedPolyPatch
58  Foam::mappedFvPatch
59  Foam::mappedFixedValueFvPatchField
60 
61 SourceFiles
62  mappedFixedPushedInternalValueFvPatchField.C
63 
64 \*---------------------------------------------------------------------------*/
65 
66 #ifndef mappedFixedPushedInternalValueFvPatchField_H
67 #define mappedFixedPushedInternalValueFvPatchField_H
68 
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 namespace Foam
74 {
75 
76 /*---------------------------------------------------------------------------*\
77  Class mappedFixedPushedInternalValueFvPatchField Declaration
78 \*---------------------------------------------------------------------------*/
79 
80 template<class Type>
81 class mappedFixedPushedInternalValueFvPatchField
82 :
83  public mappedFixedValueFvPatchField<Type>
84 {
85 
86 public:
87 
88  //- Runtime type information
89  TypeName("mappedFixedPushedInternalValue");
90 
91 
92  // Constructors
93 
94  //- Construct from patch and internal field
96  (
97  const fvPatch&,
98  const DimensionedField<Type, volMesh>&
99  );
101  //- Construct from patch, internal field and dictionary
103  (
104  const fvPatch&,
106  const dictionary&
107  );
108 
109  //- Construct by mapping given a
110  // mappedFixedPushedInternalValueFvPatchField onto a new patch
112  (
114  const fvPatch&,
116  const fvPatchFieldMapper&
117  );
118 
119  //- Construct as copy
121  (
123  );
124 
125  //- Construct and return a clone
126  virtual tmp<fvPatchField<Type>> clone() const
127  {
128  return tmp<fvPatchField<Type>>
129  (
131  (
132  *this
133  )
134  );
135  }
136 
137  //- Construct as copy setting internal field reference
139  (
142  );
143 
144  //- Construct and return a clone setting internal field reference
146  (
148  ) const
149  {
150  return tmp<fvPatchField<Type>>
151  (
153  (
154  *this,
155  iF
156  )
157  );
158  }
159 
160 
161  // Member functions
162 
163  // Evaluation functions
164 
165  //- Update the coefficients associated with the patch field
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 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
mappedFixedPushedInternalValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
This boundary condition maps the boundary values of a neighbour patch field to the boundary and inter...
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("mappedFixedPushedInternalValue")
Runtime type information.
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
Namespace for OpenFOAM.