outletMappedUniformInletFvPatchField.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-2019 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::outletMappedUniformInletFvPatchField
26 
27 Description
28  This boundary condition averages the field over the "outlet" patch specified
29  by name "outletPatch" and applies this as the uniform value of the field
30  over this patch.
31 
32 Usage
33  \table
34  Property | Description | Required | Default value
35  outletPatch | Name of outlet patch | yes |
36  phi | Flux field name | no | phi
37  \endtable
38 
39  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type outletMappedUniformInlet;
44  outletPatchName aPatch;
45  phi phi;
46  value uniform 0;
47  }
48  \endverbatim
49 
50 See also
51  Foam::fixedValueFvPatchField
52 
53 SourceFiles
54  outletMappedUniformInletFvPatchField.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef outletMappedUniformInletFvPatchField_H
59 #define outletMappedUniformInletFvPatchField_H
60 
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 namespace Foam
66 {
67 
68 /*---------------------------------------------------------------------------*\
69  Class outletMappedUniformInletFvPatchField Declaration
70 \*---------------------------------------------------------------------------*/
71 
72 template<class Type>
73 class outletMappedUniformInletFvPatchField
74 :
75  public fixedValueFvPatchField<Type>
76 {
77  // Private Data
78 
79  //- Name of the outlet patch to be mapped
80  word outletPatchName_;
81 
82  //- Name of the flux transporting the field
83  word phiName_;
84 
85 
86 public:
87 
88  //- Runtime type information
89  TypeName("outletMappedUniformInlet");
90 
91 
92  // Constructors
93 
94  //- Construct from patch and internal field
96  (
97  const fvPatch&,
99  );
100 
101  //- Construct from patch, internal field and dictionary
103  (
104  const fvPatch&,
106  const dictionary&
107  );
108 
109  //- Construct by mapping given outletMappedUniformInletFvPatchField
110  // onto a new patch
112  (
114  const fvPatch&,
116  const fvPatchFieldMapper&
117  );
118 
119  //- Copy constructor
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  }
133 
134  //- Copy constructor setting internal field reference
136  (
139  );
141  //- Construct and return a clone setting internal field reference
143  (
145  ) const
146  {
147  return tmp<fvPatchField<Type>>
148  (
150  );
151  }
152 
153 
154  // Member Functions
155 
156  // Access
158  //- Name of the outlet patch to be mapped
159  const word& outletPatchName() const
160  {
161  return outletPatchName_;
162  }
163 
164 
165  // Evaluation functions
166 
167  //- Update the coefficients associated with the patch field
168  virtual void updateCoeffs();
169 
170 
171  //- Write
172  virtual void write(Ostream&) const;
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #ifdef NoRepository
184 #endif
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 #endif
189 
190 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
This boundary condition averages the field over the "outlet" patch specified by name "outletPatch" an...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for handling words, derived from string.
Definition: word.H:59
TypeName("outletMappedUniformInlet")
Runtime type information.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
const word & outletPatchName() const
Name of the outlet patch to be mapped.
outletMappedUniformInletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Namespace for OpenFOAM.