PrghPressureFvPatchScalarField.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) 2018-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::PrghPressureFvPatchScalarField
26 
27 Description
28  This boundary condition provides the p_rgh equivalent of a pressure
29  boundary condition calculated as:
30 
31  \f[
32  p_rgh = p - \rho g (h - hRef)
33  \f]
34 
35  where
36  \vartable
37  p_rgh | Pseudo hydrostatic pressure [Pa]
38  p | Static pressure [Pa]
39  h | Height in the opposite direction to gravity
40  hRef | Reference height in the opposite direction to gravity
41  \rho | density
42  g | acceleration due to gravity [m/s^2]
43  \endtable
44 
45 SourceFiles
46  PrghPressureFvPatchScalarField.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef PrghPressureFvPatchScalarField_H
51 #define PrghPressureFvPatchScalarField_H
52 
53 #include "fvPatchField.H"
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class PrghPressureFvPatchScalarField Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 template<class PressureFvPatchScalarField>
65 class PrghPressureFvPatchScalarField
66 :
67  public PressureFvPatchScalarField
68 {
69  // Private Data
70 
71  //- Name of the density field, defaults to "rho"
72  const word rhoName_;
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("PrghPressure");
79 
80 
81  // Constructors
82 
83  //- Construct from patch and internal field
85  (
86  const fvPatch&,
87  const DimensionedField<scalar, volMesh>&
88  );
89 
90  //- Construct from patch, internal field and dictionary
92  (
93  const fvPatch&,
95  const dictionary&
96  );
97 
98  //- Construct by mapping given
99  // PrghPressureFvPatchScalarField onto a new patch
101  (
103  const fvPatch&,
105  const fvPatchFieldMapper&
106  );
107 
108  //- Disallow copy without setting internal field reference
110  (
112  ) = delete;
113 
114  //- Copy constructor setting internal field reference
116  (
119  );
120 
121  //- Construct and return a clone setting internal field reference
123  (
125  ) const
126  {
128  (
129  new PrghPressureFvPatchScalarField(*this, iF)
130  );
131  }
132 
133 
134  // Member Functions
135 
136  // Evaluation functions
137 
138  //- Update the coefficients associated with the patch field
139  virtual void updateCoeffs();
140 
141 
142  //- Write
143  virtual void write(Ostream&) const;
144 };
145 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #ifdef NoRepository
155 #endif
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #define makePrghPatchScalarField(Pressure, PrghPressure) \
160  typedef PrghPressureFvPatchScalarField<Pressure##FvPatchScalarField> \
161  PrghPressure; \
162  \
163  defineTemplateTypeNameAndDebug(PrghPressure, 0); \
164  \
165  addToPatchFieldRunTimeSelection \
166  ( \
167  fvPatchScalarField, \
168  PrghPressure \
169  )
170 
171 #endif
172 
173 // ************************************************************************* //
PrghPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal 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
virtual void write(Ostream &) const
Write.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("PrghPressure")
Runtime type information.
This boundary condition provides the p_rgh equivalent of a pressure boundary condition calculated as:...
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
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.