freestreamPressureFvPatchScalarField.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::freestreamPressureFvPatchScalarField
26 
27 Description
28  This boundary condition provides a free-stream condition for pressure.
29 
30  It is an outlet-inlet condition that uses the velocity orientation to
31  continuously blend between zero gradient for normal inlet and fixed value
32  for normal outlet flow.
33 
34 Usage
35  \table
36  Property | Description | Required | Default value
37  U | velocity field name | no | U
38  freestreamValue | freestream pressure | yes |
39  supersonic | Switch for supersonic flow | no | false
40  \endtable
41 
42  Example of the boundary condition specification:
43  \verbatim
44  <patchName>
45  {
46  type freestreamPressure;
47  freestreamValue uniform 1e5;
48  }
49  \endverbatim
50 
51 Note
52  This condition is designed to operate with a freestreamVelocity condition
53 
54 See also
55  Foam::mixedFvPatchField
56  Foam::freestreamFvPatchField
57 
58 SourceFiles
59  freestreamPressureFvPatchScalarField.C
60 
61 \*---------------------------------------------------------------------------*/
62 
63 #ifndef freestreamPressureFvPatchScalarField_H
64 #define freestreamPressureFvPatchScalarField_H
65 
66 #include "fvPatchFields.H"
67 #include "mixedFvPatchFields.H"
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class freestreamPressureFvPatchScalarField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 class freestreamPressureFvPatchScalarField
79 :
80  public mixedFvPatchScalarField
81 {
82  // Private Data
83 
84  //- Name of the velocity field
85  word UName_;
86 
87  //- Set true for supersonic freestream
88  Switch supersonic_;
89 
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("freestreamPressure");
95 
96 
97  // Constructors
98 
99  //- Construct from patch and internal field
101  (
102  const fvPatch&,
104  );
105 
106  //- Construct from patch, internal field and dictionary
108  (
109  const fvPatch&,
111  const dictionary&
112  );
113 
114  //- Construct by mapping given freestreamPressureFvPatchScalarField onto
115  // a new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Copy constructor
126  (
128  );
129 
130  //- Construct and return a clone
131  virtual tmp<fvPatchScalarField> clone() const
132  {
134  (
136  );
137  }
138 
139  //- Copy constructor setting internal field reference
141  (
144  );
145 
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
153  (
155  );
156  }
157 
158 
159  // Member Functions
160 
161  const scalarField& freestreamValue() const
162  {
163  return refValue();
164  }
165 
167  {
168  return refValue();
169  }
170 
171 
172  // Evaluation functions
173 
174  //- Update the coefficients associated with the patch field
175  virtual void updateCoeffs();
176 
177 
178  //- Write
179  virtual void write(Ostream&) const;
180 };
181 
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 } // End namespace Foam
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 #endif
190 
191 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("freestreamPressure")
Runtime type information.
freestreamPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
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
This boundary condition provides a free-stream condition for pressure.
Namespace for OpenFOAM.