All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fixedRhoFvPatchScalarField.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::fixedRhoFvPatchScalarField
26 
27 Description
28  Foam::fixedRhoFvPatchScalarField
29 
30  This boundary condition provides a fixed density inlet condition for
31  compressible solvers, where the density of calculated using:
32 
33  \f[
34  \rho = \psi p
35  \f]
36 
37  where
38  \vartable
39  p | pressure [Pa]
40  \rho | density [kg/m^3]
41  \endvartable
42 
43 
44 Usage
45  \table
46  Property | Description | Required | Default value
47  p | Pressure field name | no | p
48  psi | Compressibility field name | no | thermo:psi
49  \endtable
50 
51  Example of the boundary condition specification:
52  \verbatim
53  <patchName>
54  {
55  type fixedRho;
56  }
57  \endverbatim
58 
59 SourceFiles
60  fixedRhoFvPatchScalarField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef fixedRhoFvPatchScalarField_H
65 #define fixedRhoFvPatchScalarField_H
66 
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class fixedRhoFvPatchScalarField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 class fixedRhoFvPatchScalarField
79 :
80  public fixedValueFvPatchScalarField
81 {
82  // Private Data
83 
84  //- Pressure field name, default = "p"
85  word pName_;
86 
87  //- Compressibility field name, default = "thermo:psi"
88  word psiName_;
89 
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("fixedRho");
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 fixedRhoFvPatchScalarField
115  // onto a new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Construct and return a clone
125  virtual tmp<fvPatchScalarField> clone() const
126  {
128  (
129  new fixedRhoFvPatchScalarField(*this)
130  );
131  }
132 
133  //- Copy constructor setting internal field reference
135  (
138  );
139 
140  //- Construct and return a clone setting internal field reference
142  (
144  ) const
145  {
147  (
148  new fixedRhoFvPatchScalarField(*this, iF)
149  );
150  }
151 
152 
153  // Member Functions
154 
155  // Evaluation functions
156 
157  //- Update the coefficients associated with the patch field
158  virtual void updateCoeffs();
159 
160 
161  //- Write
162  virtual void write(Ostream&) const;
163 };
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
fixedRhoFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fixedRhoFvPatchScalarField.
TypeName("fixedRho")
Runtime type information.
Foam::fvPatchFieldMapper.
virtual void write(Ostream &) const
Write.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.