liquidThermo.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) 2023 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::liquidThermo
26 
27 Description
28  Base-class for liquid thermodynamic properties.
29 
30 See also
31  Foam::basicThermo
32 
33 SourceFiles
34  liquidThermo.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef liquidThermo_H
39 #define liquidThermo_H
40 
41 #include "LiquidThermo.H"
42 #include "rhoFluidThermo.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class liquidThermo Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class liquidThermo
54 :
55  virtual public rhoFluidThermo
56 {
57 public:
58 
59  // Public Classes
60 
61  //- Forward declare the composite class
62  class composite;
63 
64 
65  // Public Typedefs
66 
67  //- The derived type
68  template<class MixtureType>
69  using DerivedThermoType =
71 
72 
73  //- Runtime type information
74  TypeName("liquidThermo");
75 
76 
77  //- Declare run-time constructor selection table
79  (
80  autoPtr,
82  fvMesh,
83  (const fvMesh& mesh, const word& phaseName),
84  (mesh, phaseName)
85  );
86 
87 
88  // Selectors
89 
90  //- Standard selection based on fvMesh
92  (
93  const fvMesh&,
95  );
96 
97 
98  //- Destructor
99  virtual ~liquidThermo();
100 
101 
102  // Member Functions
103 
104  //- Surface tension [N/m]
105  virtual tmp<volScalarField> sigma() const = 0;
106 };
107 
108 
109 /*---------------------------------------------------------------------------*\
110  Class liquidThermo::composite Declaration
111 \*---------------------------------------------------------------------------*/
112 
114 :
116  public pureThermo,
119  public liquidThermo
120 {
121 public:
122 
123  // Constructors
124 
125  //- Construct from dictionary, mesh and phase name
126  template<class MixtureType>
127  composite
128  (
129  const dictionary& dict,
130  const MixtureType& mixture,
131  const fvMesh& mesh,
132  const word& phaseName
133  )
134  :
138  {}
139 };
140 
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
Liquid thermo implementation.
Definition: LiquidThermo.H:52
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
virtual const fvMesh & mesh() const
Return const access to the mesh.
Definition: basicThermo.H:496
virtual const word & phaseName() const
Phase name.
Definition: basicThermo.H:502
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
virtual const fvMesh & mesh() const =0
Return const access to the mesh.
virtual const word & phaseName() const =0
Phase name.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:57
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
composite(const dictionary &dict, const MixtureType &mixture, const fvMesh &mesh, const word &phaseName)
Construct from dictionary, mesh and phase name.
Definition: liquidThermo.H:127
Base-class for liquid thermodynamic properties.
Definition: liquidThermo.H:55
declareRunTimeSelectionTable(autoPtr, liquidThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection table.
TypeName("liquidThermo")
Runtime type information.
static autoPtr< liquidThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
Definition: liquidThermo.C:40
virtual tmp< volScalarField > sigma() const =0
Surface tension [N/m].
virtual ~liquidThermo()
Destructor.
Definition: liquidThermo.C:51
Base-class for multi-component thermodynamic properties.
Definition: pureThermo.H:54
Base-class for fluid thermodynamic properties based on density.
Base-class for thermodynamic properties based on density.
Definition: rhoThermo.H:54
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
static const word null
An empty word.
Definition: word.H:77
Namespace for OpenFOAM.
dictionary dict