MultiComponentPhaseModel.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) 2015 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::MultiComponentPhaseModel
26 
27 Description
28  Class which represents a phase with multiple species. Returns the species'
29  mass fractions, and their governing equations.
30 
31 SourceFiles
32  MultiComponentPhaseModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef MultiComponentPhaseModel_H
37 #define MultiComponentPhaseModel_H
38 
39 #include "phaseModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class phaseModel Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class BasePhaseModel>
52 :
53  public BasePhaseModel
54 {
55 protected:
56 
57  // Protected data
58 
59  //- Schmidt number
61 
62  //- Residual phase fraction
64 
65  //- Inert species index
67 
68 
69 public:
70 
71  // Constructors
72 
74  (
75  const phaseSystem& fluid,
76  const word& phaseName,
77  const label index
78  );
79 
80 
81  //- Destructor
82  virtual ~MultiComponentPhaseModel();
83 
84 
85  // Member Functions
86 
87  //- Correct the thermodynamics
88  virtual void correctThermo();
89 
90  //- Return the species fraction equation
92  (
93  volScalarField& Yi
94  );
95 
96  //- Constant access the species mass fractions
97  virtual const PtrList<volScalarField>& Y() const;
98 
99  //- Access the species mass fractions
100  virtual PtrList<volScalarField>& Y();
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #ifdef NoRepository
111 # include "MultiComponentPhaseModel.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
multiphaseSystem & fluid
Definition: createFields.H:10
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:61
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:67
virtual const PtrList< volScalarField > & Y() const
Constant access the species mass fractions.
A class for handling words, derived from string.
Definition: word.H:59
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
virtual void correctThermo()
Correct the thermodynamics.
Namespace for OpenFOAM.
dimensionedScalar residualAlpha_
Residual phase fraction.
virtual ~MultiComponentPhaseModel()
Destructor.
dimensionedScalar Sc_
Schmidt number.
label inertIndex_
Inert species index.
virtual tmp< fvScalarMatrix > YiEqn(volScalarField &Yi)
Return the species fraction equation.
MultiComponentPhaseModel(const phaseSystem &fluid, const word &phaseName, const label index)
Class which represents a phase with multiple species. Returns the species&#39; mass fractions, and their governing equations.
A class for managing temporary objects.
Definition: PtrList.H:118