pressureReference.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) 2017-2021 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::pressureReference
26 
27 Description
28  Provides controls for the pressure reference in closed-volume simulations
29 
30 SourceFiles
31  pressureReferenceI.H
32  pressureReference.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef pressureReference_H
37 #define pressureReference_H
38 
39 #include "dimensionedScalar.H"
40 #include "volFieldsFwd.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class pressureReference Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private Data
54 
55  //- Optional cell in which the reference pressure is set
56  label refCell_;
57 
58  //- Optional pressure reference level
59  scalar refValue_;
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from the simple/pimple sub-dictionary
67  // supporting the pressure and derived pressure fields (e.g. p_rgh)
69  (
70  const volScalarField& p,
71  const volScalarField& pRef,
72  const dictionary& dict,
73  const bool pRefRequired = true
74  );
75 
76  //- Construct from the simple/pimple sub-dictionary
78  (
79  const volScalarField& p,
80  const dictionary& dict,
81  const bool pRefRequired = true
82  );
83 
84 
85  // Member Functions
86 
87  //- Return the cell in which the reference pressure is set
88  inline label refCell() const;
89 
90  //- Return the pressure reference level
91  inline scalar refValue() const;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #include "pressureReferenceI.H"
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
Generic GeometricField class.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Provides controls for the pressure reference in closed-volume simulations.
pressureReference(const volScalarField &p, const volScalarField &pRef, const dictionary &dict, const bool pRefRequired=true)
Construct from the simple/pimple sub-dictionary.
scalar refValue() const
Return the pressure reference level.
label refCell() const
Return the cell in which the reference pressure is set.
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
dictionary dict
volScalarField & p