twoPhaseMixture.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2014 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::twoPhaseMixture
26 
27 Description
28  A two-phase mixture model
29 
30 SourceFiles
31  twoPhaseMixture.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef twoPhaseMixture_H
36 #define twoPhaseMixture_H
37 
38 #include "volFields.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class twoPhaseMixture Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class twoPhaseMixture
50 {
51 protected:
52 
53  // Protected data
54 
57 
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from components
68  (
69  const fvMesh& mesh,
70  const dictionary& dict
71  );
72 
73 
74  //- Destructor
76  {}
77 
78 
79  // Member Functions
80 
81  const word& phase1Name() const
82  {
83  return phase1Name_;
84  }
85 
86  const word& phase2Name() const
87  {
88  return phase2Name_;
89  }
90 
91  //- Return the phase-fraction of phase 1
92  const volScalarField& alpha1() const
93  {
94  return alpha1_;
95  }
96 
97  //- Return the phase-fraction of phase 1
99  {
100  return alpha1_;
101  }
102 
103  //- Return the phase-fraction of phase 2
104  const volScalarField& alpha2() const
105  {
106  return alpha2_;
107  }
108 
109  //- Return the phase-fraction of phase 2
111  {
112  return alpha2_;
113  }
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A two-phase mixture model.
const word & phase2Name() const
volScalarField alpha1_
A class for handling words, derived from string.
Definition: word.H:59
dynamicFvMesh & mesh
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
const volScalarField & alpha1() const
Return the phase-fraction of phase 1.
const volScalarField & alpha2() const
Return the phase-fraction of phase 2.
dictionary dict
const word & phase1Name() const
volScalarField alpha2_
~twoPhaseMixture()
Destructor.
twoPhaseMixture(const fvMesh &mesh, const dictionary &dict)
Construct from components.