pressureNormalInletOutletVelocityFvPatchVectorField.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::pressureNormalInletOutletVelocityFvPatchVectorField
26 
27 Description
28  This velocity inlet/outlet boundary condition is applied to patches where
29  the pressure is specified. A zero-gradient condition is applied for
30  outflow (as defined by the flux); for inflow, the velocity is obtained from
31  the flux with a direction normal to the patch faces.
32 
33 Usage
34  \table
35  Property | Description | Required | Default value
36  phi | flux field name | no | phi
37  rho | density field name | no | rho
38  \endtable
39 
40  Example of the boundary condition specification:
41  \verbatim
42  <patchName>
43  {
44  type pressureNormalInletOutletVelocity;
45  phi phi;
46  rho rho;
47  value uniform 0;
48  }
49  \endverbatim
50 
51  Note:
52  Sign conventions:
53  - positive flux (out of domain): apply zero-gradient condition
54  - negative flux (into of domain): derive from the flux and patch-normal
55  direction
56 
57 See also
58  Foam::mixedFvPatchVectorField
59 
60 SourceFiles
61  pressureNormalInletOutletVelocityFvPatchVectorField.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef pressureNormalInletOutletVelocityFvPatchVectorField_H
66 #define pressureNormalInletOutletVelocityFvPatchVectorField_H
67 
68 #include "fvPatchFields.H"
69 #include "mixedFvPatchFields.H"
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 namespace Foam
74 {
75 
76 /*---------------------------------------------------------------------------*\
77  Class pressureNormalInletOutletVelocityFvPatchVectorField Declaration
78 \*---------------------------------------------------------------------------*/
79 
80 class pressureNormalInletOutletVelocityFvPatchVectorField
81 :
82  public mixedFvPatchVectorField
83 {
84  // Private Data
85 
86  //- Flux field name
87  word phiName_;
88 
89  //- Density field name
90  word rhoName_;
91 
92 
93 public:
94 
95  //- Runtime type information
96  TypeName("pressureNormalInletOutletVelocity");
97 
98 
99  // Constructors
100 
101  //- Construct from patch, internal field and dictionary
103  (
104  const fvPatch&,
106  const dictionary&
107  );
108 
109  //- Construct by mapping given
110  // pressureNormalInletOutletVelocityFvPatchVectorField
111  // onto a new patch
113  (
115  const fvPatch&,
117  const fieldMapper&
118  );
119 
120  //- Disallow copy without setting internal field reference
122  (
124  ) = delete;
125 
126  //- Copy constructor setting internal field reference
128  (
131  );
132 
133  //- Construct and return a clone setting internal field reference
135  (
137  ) const
138  {
140  (
142  (
143  *this,
144  iF
145  )
146  );
147  }
148 
149 
150  // Member Functions
151 
152  // Attributes
153 
154  //- Return true: this patch field is altered by assignment
155  virtual bool assignable() const
156  {
157  return true;
158  }
159 
160 
161  // Access
162 
163  //- Return the name of rho
164  const word& rhoName() const
165  {
166  return rhoName_;
167  }
168 
169  //- Return reference to the name of rho to allow adjustment
170  word& rhoName()
171  {
172  return rhoName_;
173  }
174 
175  //- Return the name of phi
176  const word& phiName() const
177  {
178  return phiName_;
179  }
180 
181 
182  //- Return reference to the name of phi to allow adjustment
183  word& phiName()
184  {
185  return phiName_;
186  }
187 
188 
189  //- Update the coefficients associated with the patch field
190  virtual void updateCoeffs();
191 
192  //- Write
193  virtual void write(Ostream&) const;
194 
195 
196  // Member Operators
197 
198  virtual void operator=(const fvPatchField<vector>& pvf);
199 };
200 
201 
202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
203 
204 } // End namespace Foam
205 
206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
207 
208 #endif
209 
210 // ************************************************************************* //
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
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
This velocity inlet/outlet boundary condition is applied to patches where the pressure is specified....
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
pressureNormalInletOutletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("pressureNormalInletOutletVelocity")
Runtime type information.
virtual bool assignable() const
Return true: this patch field is altered by assignment.
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.