fixedMeanOutletInletFvPatchField.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) 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::fixedMeanOutletInletFvPatchField
26 
27 Description
28  This boundary condition extrapolates field to the patch using the near-cell
29  values and adjusts the distribution to match the specified, optionally
30  time-varying, mean value. This extrapolated field is applied as a
31  fixedValue for outflow faces but zeroGradient is applied to inflow faces.
32 
33  This boundary condition can be applied to pressure when inletOutlet is
34  applied to the velocity so that a zeroGradient condition is applied to the
35  pressure at inflow faces where the velocity is specified to avoid an
36  unphysical over-specification of the set of boundary conditions.
37 
38 Usage
39  \table
40  Property | Description | Required | Default value
41  meanValue | mean value Function1 | yes |
42  phi | Flux field name | no | phi
43  \endtable
44 
45  Example of the boundary condition specification:
46  \verbatim
47  <patchName>
48  {
49  type fixedMeanOutletInlet;
50  meanValue 1.0;
51  }
52  \endverbatim
53 
54 See also
55  Foam::fixedMeanFvPatchField
56  Foam::outletInletFvPatchField
57  Foam::Function1Types
58 
59 SourceFiles
60  fixedMeanOutletInletFvPatchField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef fixedMeanOutletInletFvPatchField_H
65 #define fixedMeanOutletInletFvPatchField_H
66 
68 #include "Function1.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 
75 /*---------------------------------------------------------------------------*\
76  Class fixedMeanOutletInletFvPatchField Declaration
77 \*---------------------------------------------------------------------------*/
78 
79 template<class Type>
80 class fixedMeanOutletInletFvPatchField
81 :
82  public outletInletFvPatchField<Type>
83 {
84  // Private data
85 
86  //- MeanValue value the field is adjusted to maintain
87  autoPtr<Function1<Type>> meanValue_;
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("fixedMeanOutletInlet");
94 
95 
96  // Constructors
97 
98  //- Construct from patch and internal field
100  (
101  const fvPatch&,
103  );
104 
105  //- Construct from patch, internal field and dictionary
107  (
108  const fvPatch&,
110  const dictionary&
111  );
112 
113  //- Construct by mapping given fixedMeanOutletInletFvPatchField
114  // onto a new patch
116  (
118  const fvPatch&,
120  const fvPatchFieldMapper&
121  );
122 
123  //- Construct as copy
125  (
127  );
128 
129  //- Construct and return a clone
130  virtual tmp<fvPatchField<Type>> clone() const
131  {
132  return tmp<fvPatchField<Type>>
133  (
135  );
136  }
137 
138  //- Construct as copy setting internal field reference
140  (
143  );
145  //- Construct and return a clone setting internal field reference
147  (
149  ) const
150  {
151  return tmp<fvPatchField<Type>>
152  (
154  );
155  }
156 
157 
158  // Member functions
159 
160  //- Update the coefficients associated with the patch field
161  virtual void updateCoeffs();
162 
163  //- Write
164  virtual void write(Ostream&) const;
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #ifdef NoRepository
176 #endif
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 #endif
181 
182 // ************************************************************************* //
TypeName("fixedMeanOutletInlet")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
fixedMeanOutletInletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
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.
This boundary condition extrapolates field to the patch using the near-cell values and adjusts the di...