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-2023 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, internal field and dictionary
96  (
97  const fvPatch&,
99  const dictionary&
100  );
101 
102  //- Construct by mapping given outletMappedUniformInletFvPatchField
103  // onto a new patch
105  (
107  const fvPatch&,
109  const fieldMapper&
110  );
111 
112  //- Disallow copy without setting internal field reference
114  (
116  ) = delete;
117 
118  //- Copy constructor setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
131  return tmp<fvPatchField<Type>>
132  (
134  );
135  }
136 
137 
138  // Member Functions
139 
140  // Access
141 
142  //- Name of the outlet patch to be mapped
143  const word& outletPatchName() const
144  {
145  return outletPatchName_;
146  }
147 
148 
149  // Evaluation functions
150 
151  //- Update the coefficients associated with the patch field
152  virtual void updateCoeffs();
153 
154 
155  //- Write
156  virtual void write(Ostream&) const;
157 };
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #ifdef NoRepository
168 #endif
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
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:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:204
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
This boundary condition averages the field over the "outlet" patch specified by name "outletPatch" an...
const word & outletPatchName() const
Name of the outlet patch to be mapped.
outletMappedUniformInletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("outletMappedUniformInlet")
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.