pressureInletOutletParSlipVelocityFvPatchVectorField.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-2020 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::pressureInletOutletParSlipVelocityFvPatchVectorField
26 
27 Description
28  This velocity inlet/outlet boundary condition for pressure boundary where
29  the pressure is specified. A zero-gradient is applied for outflow (as
30  defined by the flux); for inflow, the velocity is obtained from the flux
31  with the specified inlet direction.
32 
33  A slip condition is applied tangential to the patch.
34 
35 Usage
36  \table
37  Property | Description | Required | Default value
38  phi | flux field name | no | phi
39  rho | density field name | no | rho
40  \endtable
41 
42  Example of the boundary condition specification:
43  \verbatim
44  <patchName>
45  {
46  type pressureInletOutletParSlipVelocity;
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 with specified
55  direction
56 
57 See also
58  Foam::mixedFvPatchVectorField
59  Foam::pressureDirectedInletOutletVelocityFvPatchVectorField
60 
61 SourceFiles
62  pressureInletOutletParSlipVelocityFvPatchVectorField.C
63 
64 \*---------------------------------------------------------------------------*/
65 
66 #ifndef pressureInletOutletParSlipVelocityFvPatchVectorField_H
67 #define pressureInletOutletParSlipVelocityFvPatchVectorField_H
68 
69 #include "fvPatchFields.H"
70 #include "mixedFvPatchFields.H"
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 namespace Foam
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class pressureInletOutletParSlipVelocityFvPatchVectorField Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 class pressureInletOutletParSlipVelocityFvPatchVectorField
82 :
83  public mixedFvPatchVectorField
84 {
85  // Private Data
86 
87  //- Flux field name
88  word phiName_;
89 
90  //- Density field name
91  word rhoName_;
92 
93 
94 public:
95 
96  //- Runtime type information
97  TypeName("pressureInletOutletParSlipVelocity");
98 
99 
100  // Constructors
101 
102  //- Construct from patch and internal field
104  (
105  const fvPatch&,
107  );
108 
109  //- Construct by mapping given
110  // pressureInletOutletParSlipVelocityFvPatchVectorField
111  // onto a new patch
113  (
115  const fvPatch&,
117  const fvPatchFieldMapper&
118  );
119 
120  //- Construct from patch, internal field and dictionary
122  (
123  const fvPatch&,
125  const dictionary&
126  );
127 
128  //- Disallow copy without setting internal field reference
130  (
132  ) = delete;
133 
134  //- Copy constructor setting internal field reference
136  (
139  );
140 
141  //- Construct and return a clone setting internal field reference
143  (
145  ) const
146  {
148  (
150  (
151  *this,
152  iF
153  )
154  );
155  }
156 
158  // Member Functions
159 
160  // Attributes
161 
162  //- Return true: this patch field is altered by assignment
163  virtual bool assignable() const
164  {
165  return true;
166  }
167 
168 
169  // Access
170 
171  //- Return the name of rho
172  const word& rhoName() const
173  {
174  return rhoName_;
175  }
176 
177  //- Return reference to the name of rho to allow adjustment
178  word& rhoName()
179  {
180  return rhoName_;
181  }
182 
183  //- Return the name of phi
184  const word& phiName() const
185  {
186  return phiName_;
187  }
188 
189  //- Return reference to the name of phi to allow adjustment
190  word& phiName()
191  {
192  return phiName_;
193  }
194 
195 
196  //- Update the coefficients associated with the patch field
197  virtual void updateCoeffs();
199  //- Write
200  virtual void write(Ostream&) const;
201 
202 
203  // Member Operators
205  virtual void operator=(const fvPatchField<vector>& pvf);
206 };
207 
208 
209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210 
211 } // End namespace Foam
212 
213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
214 
215 #endif
216 
217 // ************************************************************************* //
pressureInletOutletParSlipVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
TypeName("pressureInletOutletParSlipVelocity")
Runtime type information.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
virtual bool assignable() const
Return true: this patch field is altered by assignment.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
This velocity inlet/outlet boundary condition for pressure boundary where the pressure is specified...
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.