All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pureThermo.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::pureThermo
26 
27 Description
28  Base-class for multi-component thermodynamic properties.
29 
30 See also
31  Foam::basicThermo
32 
33 SourceFiles
34  pureThermo.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef pureThermo_H
39 #define pureThermo_H
40 
41 #include "basicThermo.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class pureThermo Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class pureThermo
53 :
54  virtual public basicThermo
55 {
56 public:
57 
58  //- Destructor
59  virtual ~pureThermo();
60 
61 
62  // Member Functions
63 
64  //- Get the slicer
65  inline nil Yslicer() const;
66 
67  //- Get the composition of an internal cell
68  inline nil cellComposition
69  (
70  const nil,
71  const label celli
72  ) const;
73 
74  //- Get the composition of a boundary face
76  (
77  const nil,
78  const label patchi,
79  const label facei
80  ) const;
81 
82  //- Get the slicer for the given source
83  inline nil Yslicer(const fvSource&) const;
84 
85  //- Get the composition of a source cell
86  inline nil sourceCellComposition(const nil, const label i) const;
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #include "pureThermoI.H"
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
Base class for finite volume sources.
Definition: fvSource.H:52
A zero-sized class without any storage. Used, for example, in HashSet.
Definition: nil.H:59
Base-class for multi-component thermodynamic properties.
Definition: pureThermo.H:54
nil cellComposition(const nil, const label celli) const
Get the composition of an internal cell.
Definition: pureThermoI.H:37
nil Yslicer() const
Get the slicer.
Definition: pureThermoI.H:30
nil sourceCellComposition(const nil, const label i) const
Get the composition of a source cell.
Definition: pureThermoI.H:64
nil patchFaceComposition(const nil, const label patchi, const label facei) const
Get the composition of a boundary face.
Definition: pureThermoI.H:47
virtual ~pureThermo()
Destructor.
Definition: pureThermo.C:30
label patchi
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