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-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::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
53  condition
54 
55 See also
56  Foam::mixedFvPatchField
57  Foam::freestreamFvPatchField
58 
59 SourceFiles
60  freestreamPressureFvPatchScalarField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef freestreamPressureFvPatchScalarField_H
65 #define freestreamPressureFvPatchScalarField_H
66 
67 #include "fvPatchFields.H"
68 #include "mixedFvPatchFields.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 
75 /*---------------------------------------------------------------------------*\
76  Class freestreamPressureFvPatchScalarField Declaration
77 \*---------------------------------------------------------------------------*/
78 
79 class freestreamPressureFvPatchScalarField
80 :
81  public mixedFvPatchScalarField
82 {
83  // Private Data
84 
85  //- Name of the velocity field
86  word UName_;
87 
88  //- Set true for supersonic freestream
89  Switch supersonic_;
90 
91 
92 public:
93 
94  //- Runtime type information
95  TypeName("freestreamPressure");
96 
97 
98  // Constructors
99 
100  //- Construct from patch, internal field and dictionary
102  (
103  const fvPatch&,
105  const dictionary&
106  );
107 
108  //- Construct by mapping given freestreamPressureFvPatchScalarField onto
109  // a new patch
111  (
113  const fvPatch&,
115  const fieldMapper&
116  );
117 
118  //- Disallow copy without setting internal field reference
120  (
122  ) = delete;
123 
124  //- Copy constructor setting internal field reference
126  (
129  );
130 
131  //- Construct and return a clone setting internal field reference
133  (
135  ) const
136  {
138  (
140  );
141  }
142 
143 
144  // Member Functions
145 
146  const scalarField& freestreamValue() const
147  {
148  return refValue();
149  }
150 
152  {
153  return refValue();
154  }
155 
156 
157  // Evaluation functions
158 
159  //- Update the coefficients associated with the patch field
160  virtual void updateCoeffs();
161 
162 
163  //- Write
164  virtual void write(Ostream&) const;
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #endif
175 
176 // ************************************************************************* //
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
This boundary condition provides a free-stream condition for pressure.
freestreamPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
TypeName("freestreamPressure")
Runtime type information.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.