fixedRhoFvPatchScalarField.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-2012 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 Group
28  grpInletBoundaryConditions
29 
30 Description
31  Foam::fixedRhoFvPatchScalarField
32 
33  This boundary condition provides a fixed density inlet condition for
34  compressible solvers, where the density of calculated using:
35 
36  \f{
37  \rho = \psi p
38  \f]
39 
40  where
41  \vartable
42  p | pressure [Pa]
43  \rho | density [kg/m3]
44  \endvartable
45 
46 
47  \heading Patch usage
48 
49  \table
50  Property | Description | Required | Default value
51  pName | Pressure field name | no | p
52  psiName | Compressibility field name | no | thermo:psi
53  \endtable
54 
55  Example of the boundary condition specification:
56  \verbatim
57  myPatch
58  {
59  type fixedRho;
60  }
61  \endverbatim
62 
63 SourceFiles
64  fixedRhoFvPatchScalarField.C
65 
66 \*---------------------------------------------------------------------------*/
67 
68 #ifndef fixedRhoFvPatchScalarField_H
69 #define fixedRhoFvPatchScalarField_H
70 
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 namespace Foam
76 {
77 
78 /*---------------------------------------------------------------------------*\
79  Class fixedRhoFvPatchScalarField Declaration
80 \*---------------------------------------------------------------------------*/
81 
82 class fixedRhoFvPatchScalarField
83 :
84  public fixedValueFvPatchScalarField
85 {
86 
87 private:
88 
89  // Private data
90 
91  //- Pressure field name, default = "p"
92  word pName_;
93 
94  //- Compressibility field name, default = "thermo:psi"
95  word psiName_;
96 
97 
98 public:
99 
100  //- Runtime type information
101  TypeName("fixedRho");
102 
103 
104  // Constructors
105 
106  //- Construct from patch and internal field
108  (
109  const fvPatch&,
111  );
112 
113  //- Construct from patch, internal field and dictionary
115  (
116  const fvPatch&,
118  const dictionary&
119  );
120 
121  //- Construct by mapping given fixedRhoFvPatchScalarField
122  // onto a new patch
124  (
126  const fvPatch&,
128  const fvPatchFieldMapper&
129  );
130 
131  //- Construct as copy
133  (
135  );
136 
137  //- Construct and return a clone
138  virtual tmp<fvPatchScalarField> clone() const
139  {
141  (
142  new fixedRhoFvPatchScalarField(*this)
143  );
144  }
145 
146  //- Construct as copy setting internal field reference
148  (
151  );
152 
153  //- Construct and return a clone setting internal field reference
155  (
157  ) const
158  {
160  (
161  new fixedRhoFvPatchScalarField(*this, iF)
162  );
163  }
164 
165 
166  // Member functions
167 
168  // Evaluation functions
169 
170  //- Update the coefficients associated with the patch field
171  virtual void updateCoeffs();
172 
173 
174  //- Write
175  virtual void write(Ostream&) const;
176 };
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 } // End namespace Foam
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #endif
186 
187 // ************************************************************************* //
Foam::fixedRhoFvPatchScalarField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
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
TypeName("fixedRho")
Runtime type information.
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.
virtual void write(Ostream &) const
Write.
A class for managing temporary objects.
Definition: PtrList.H:118
virtual void updateCoeffs()
Update the coefficients associated with the patch field.