incompressibleTwoPhases.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) 2022-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::incompressibleTwoPhases
26 
27 Description
28  Interface to two constant density phases
29 
30 SourceFiles
31  incompressibleTwoPhases.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef incompressibleTwoPhases_H
36 #define incompressibleTwoPhases_H
37 
38 #include "twoPhases.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class incompressibleTwoPhases Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  virtual public twoPhases
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("incompressibleTwoPhases");
57 
58 
59  // Constructors
60 
61  //- Default construct
63  {}
64 
65 
66  //- Destructor
67  virtual ~incompressibleTwoPhases()
68  {}
69 
70 
71  // Member Functions
72 
73  //- Return the density of phase1
74  virtual const dimensionedScalar& rho1() const = 0;
75 
76  //- Return the density of phase2
77  virtual const dimensionedScalar& rho2() const = 0;
78 
79  //- Return the density of a given phase
80  inline const dimensionedScalar& rho(const bool index) const
81  {
82  return index ? rho2() : rho1();
83  }
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
Interface to two constant density phases.
const dimensionedScalar & rho(const bool index) const
Return the density of a given phase.
incompressibleTwoPhases()
Default construct.
TypeName("incompressibleTwoPhases")
Runtime type information.
virtual ~incompressibleTwoPhases()
Destructor.
virtual const dimensionedScalar & rho2() const =0
Return the density of phase2.
virtual const dimensionedScalar & rho1() const =0
Return the density of phase1.
Interface to two phases.
Definition: twoPhases.H:49
bool index(const word &name) const
Return the index associated with a given phase name.
Definition: twoPhases.H:77
Namespace for OpenFOAM.