VoFMixture.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::VoFMixture
26 
27 Description
28  Two-phase VoF mixture
29 
30 SourceFiles
31  VoFMixture.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef VoFMixture_H
36 #define VoFMixture_H
37 
38 #include "volFieldsFwd.H"
39 #include "surfaceFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class fvMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class VoFMixture Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class VoFMixture
53 {
54 
55 public:
56 
57  TypeName("VoFMixture");
58 
59 
60  // Constructors
61 
62  //- Construct from components
63  VoFMixture(const fvMesh& mesh);
64 
65 
66  //- Destructor
67  virtual ~VoFMixture()
68  {}
69 
70 
71  // Member Functions
72 
73  //- Return the mixture density
74  virtual const volScalarField& rho() const = 0;
75 
76  //- Correct the mixture properties
77  virtual void correct() = 0;
78 
79  //- Read base phaseProperties dictionary
80  virtual bool read() = 0;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Generic GeometricField class.
Two-phase VoF mixture.
Definition: VoFMixture.H:52
virtual bool read()=0
Read base phaseProperties dictionary.
TypeName("VoFMixture")
virtual void correct()=0
Correct the mixture properties.
virtual ~VoFMixture()
Destructor.
Definition: VoFMixture.H:66
virtual const volScalarField & rho() const =0
Return the mixture density.
VoFMixture(const fvMesh &mesh)
Construct from components.
Definition: VoFMixture.C:37
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Namespace for OpenFOAM.