mappedFixedInternalValueFvPatchField.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 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::mappedFixedInternalValueFvPatchField
29 
30 Group
31  grpGenericBoundaryConditions grpCoupledBoundaryConditions
32 
33 Description
34  This boundary condition maps the boundary and internal values of a
35  neighbour patch field to the boundary and internal values of *this.
36 
37 Usage
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  \verbatim
46  <patchName>
47  {
48  type mappedFixedInternalValue;
49  field T;
50  setAverage false;
51  average 0;
52  value uniform 0;
53  }
54  \endverbatim
55 
56 Note
57  This boundary condition can only be applied to patches that are of
58  the \c mappedPolyPatch type.
59 
60 See also
61  Foam::mappedPatchBase
62  Foam::mappedPolyPatch
63  Foam::mappedFvPatch
64  Foam::mappedFixedValueFvPatchField
65 
66 SourceFiles
67  mappedFixedInternalValueFvPatchField.C
68 
69 \*---------------------------------------------------------------------------*/
70 
71 #ifndef mappedFixedInternalValueFvPatchField_H
72 #define mappedFixedInternalValueFvPatchField_H
73 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 namespace Foam
79 {
80 
81 /*---------------------------------------------------------------------------*\
82  Class mappedFixedInternalValueFvPatchField Declaration
83 \*---------------------------------------------------------------------------*/
84 
85 template<class Type>
86 class mappedFixedInternalValueFvPatchField
87 :
88  public mappedFixedValueFvPatchField<Type>
89 {
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("mappedFixedInternalValue");
95 
96 
97  // Constructors
98 
99  //- Construct from patch and internal field
101  (
102  const fvPatch&,
103  const DimensionedField<Type, volMesh>&
104  );
105 
106  //- Construct from patch, internal field and dictionary
108  (
109  const fvPatch&,
111  const dictionary&
112  );
113 
114  //- Construct by mapping given
115  // mappedFixedInternalValueFvPatchField onto a new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Construct as copy
126  (
128  );
129 
130  //- Construct and return a clone
131  virtual tmp<fvPatchField<Type>> clone() const
132  {
133  return tmp<fvPatchField<Type>>
134  (
136  );
137  }
138 
139  //- Construct as copy setting internal field reference
141  (
144  );
145 
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
152  return tmp<fvPatchField<Type>>
153  (
155  );
156  }
157 
158 
159  // Member functions
160 
161  //- Update the coefficients associated with the patch field
162  virtual void updateCoeffs();
163 
164  //- Write
165  virtual void write(Ostream& os) const;
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #ifdef NoRepository
177 #endif
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #endif
182 
183 // ************************************************************************* //
Foam::mappedFixedValueFvPatchField
This boundary condition maps the value at a set of cells or patch faces back to *this.
Definition: mappedFixedValueFvPatchField.H:125
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::mappedFixedInternalValueFvPatchField
This boundary condition maps the boundary and internal values of a neighbour patch field to the bound...
Definition: mappedFixedInternalValueFvPatchField.H:105
Foam::mappedFixedInternalValueFvPatchField::TypeName
TypeName("mappedFixedInternalValue")
Runtime type information.
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
mappedFixedValueFvPatchField.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::mappedFixedInternalValueFvPatchField::mappedFixedInternalValueFvPatchField
mappedFixedInternalValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: mappedFixedInternalValueFvPatchField.C:36
mappedFixedInternalValueFvPatchField.C
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::mappedFixedInternalValueFvPatchField::write
virtual void write(Ostream &os) const
Write.
Definition: mappedFixedInternalValueFvPatchField.C:191
Foam::mappedFixedInternalValueFvPatchField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: mappedFixedInternalValueFvPatchField.C:98
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::mappedFixedInternalValueFvPatchField::clone
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Definition: mappedFixedInternalValueFvPatchField.H:150