mappedFixedPushedInternalValueFvPatchField.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2018 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::mappedFixedPushedInternalValueFvPatchField
29
30Group
31 grpGenericBoundaryConditions grpCoupledBoundaryConditions
32
33Description
34 This boundary condition maps the boundary values of a neighbour patch
35 field to the boundary and internal cell values of *this.
36
37Usage
38 \table
39 Property | Description | Required | Default
40 field | name of field to be mapped | no | this field name
41 setAverage | Use average value | no | false |
42 average | Average value to use if \c setAverage = yes | partly |
43 \endtable
44
45 Example of the boundary condition specification:
46 \verbatim
47 <patchName>
48 {
49 type mappedFixedPushedInternalValue;
50 field T;
51 setAverage no;
52 average 0;
53 value uniform 0;
54 }
55 \endverbatim
56
57Note
58 This boundary condition can only be applied to patches that are of
59 the \c mappedPolyPatch type.
60
61See also
62 Foam::mappedPatchBase
63 Foam::mappedPolyPatch
64 Foam::mappedFvPatch
65 Foam::mappedFixedValueFvPatchField
66
67SourceFiles
68 mappedFixedPushedInternalValueFvPatchField.C
69
70\*---------------------------------------------------------------------------*/
71
72#ifndef mappedFixedPushedInternalValueFvPatchField_H
73#define mappedFixedPushedInternalValueFvPatchField_H
74
76
77// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78
79namespace Foam
80{
81
82/*---------------------------------------------------------------------------*\
83 Class mappedFixedPushedInternalValueFvPatchField Declaration
84\*---------------------------------------------------------------------------*/
85
86template<class Type>
87class mappedFixedPushedInternalValueFvPatchField
88:
89 public mappedFixedValueFvPatchField<Type>
90{
91
92public:
93
94 //- Runtime type information
95 TypeName("mappedFixedPushedInternalValue");
96
97
98 // Constructors
99
100 //- Construct from patch and internal field
102 (
103 const fvPatch&,
104 const DimensionedField<Type, volMesh>&
105 );
106
107 //- Construct from patch, internal field and dictionary
109 (
110 const fvPatch&,
112 const dictionary&
113 );
114
115 //- Construct by mapping given a
116 // mappedFixedPushedInternalValueFvPatchField onto a new patch
118 (
120 const fvPatch&,
122 const fvPatchFieldMapper&
123 );
124
125 //- Construct as copy
127 (
129 );
130
131 //- Construct and return a clone
132 virtual tmp<fvPatchField<Type>> clone() const
133 {
135 (
137 (
138 *this
139 )
140 );
141 }
142
143 //- Construct as copy setting internal field reference
145 (
148 );
149
150 //- Construct and return a clone setting internal field reference
154 ) const
155 {
157 (
159 (
160 *this,
161 iF
162 )
163 );
164 }
165
166
167 // Member functions
168
169 // Evaluation functions
170
171 //- Update the coefficients associated with the patch field
172 virtual void updateCoeffs();
173
174 //- Write
175 virtual void write(Ostream&) const;
176};
177
178
179// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180
181} // End namespace Foam
182
183// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184
185#ifdef NoRepository
187#endif
188
189// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
190
191#endif
192
193// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
This boundary condition maps the boundary values of a neighbour patch field to the boundary and inter...
TypeName("mappedFixedPushedInternalValue")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
mappedFixedPushedInternalValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
virtual tmp< fvPatchField< Type > > clone(const DimensionedField< Type, volMesh > &iF) const
Construct and return a clone setting internal field reference.
This boundary condition maps the value at a set of cells or patch faces back to *this.
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73