freestreamPressureFvPatchScalarField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 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 Group
28  grpInletBoundaryConditions grpOutletBoundaryConditions
29 
30 Description
31  This boundary condition provides a free-stream condition for pressure.
32  It is a zero-gradient condition that constrains the flux across the patch
33  based on the free-stream velocity.
34 
35  \heading Patch usage
36 
37  \table
38  Property | Description | Required | Default value
39  U | velocity field name | no | U
40  phi | flux field name | no | phi
41  rho | density field name | no | none
42  \endtable
43 
44  Example of the boundary condition specification:
45  \verbatim
46  myPatch
47  {
48  type freestreamPressure;
49  }
50  \endverbatim
51 
52 Note
53  This condition is designed to operate with a freestream velocity condition
54 
55 SeeAlso
56  Foam::zeroGradientFvPatchField
57  Foam::freestreamFvPatchField
58 
59 SourceFiles
60  freestreamPressureFvPatchScalarField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef freestreamPressureFvPatchScalarFields_H
65 #define freestreamPressureFvPatchScalarFields_H
66 
67 #include "fvPatchFields.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 
75 /*---------------------------------------------------------------------------*\
76  Class freestreamPressureFvPatchScalarField Declaration
77 \*---------------------------------------------------------------------------*/
78 
79 class freestreamPressureFvPatchScalarField
80 :
81  public zeroGradientFvPatchScalarField
82 {
83  // Private data
84 
85  //- Name of the velocity field
86  word UName_;
87 
88  //- Name of the flux transporting the field
89  word phiName_;
90 
91  //- Name of the density field used to normalise the mass flux
92  // if neccessary
93  word rhoName_;
94 
95 
96 public:
97 
98  //- Runtime type information
99  TypeName("freestreamPressure");
100 
101 
102  // Constructors
103 
104  //- Construct from patch and internal field
106  (
107  const fvPatch&,
109  );
110 
111  //- Construct from patch, internal field and dictionary
113  (
114  const fvPatch&,
116  const dictionary&
117  );
118 
119  //- Construct by mapping given freestreamPressureFvPatchScalarField onto
120  // a new patch
122  (
124  const fvPatch&,
126  const fvPatchFieldMapper&
127  );
128 
129  //- Construct as copy
131  (
133  );
134 
135  //- Construct and return a clone
136  virtual tmp<fvPatchScalarField> clone() const
137  {
139  (
141  );
142  }
143 
144  //- Construct as copy setting internal field reference
146  (
149  );
150 
151  //- Construct and return a clone setting internal field reference
153  (
155  ) const
156  {
158  (
160  );
161  }
162 
163 
164  // Member functions
165 
166  // Evaluation functions
167 
168  //- Update the coefficients associated with the patch field
169  virtual void updateCoeffs();
170 
171 
172  //- Write
173  virtual void write(Ostream&) const;
174 };
175 
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 } // End namespace Foam
180 
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 
183 #endif
184 
185 // ************************************************************************* //
virtual tmp< fvPatchScalarField > 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...
freestreamPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a free-stream condition for pressure. It is a zero-gradient conditio...
TypeName("freestreamPressure")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:118