FreeFOAM The Cross-Platform CFD Toolkit
SingleMixtureFraction.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) 2008-2010 OpenCFD Ltd.
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::SingleMixtureFraction
26 
27 Description
28  Templated parcel multi-phase, multi-component class
29 
30 SourceFiles
31  SingleMixtureFraction.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef SingleMixtureFraction_H
36 #define SingleMixtureFraction_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class SingleMixtureFraction Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
51 :
52  public CompositionModel<CloudType>
53 {
54  // Private data
55 
56  // Indices of the phases
57 
58  //- Gas
59  label idGas_;
60 
61  //- Liquid
62  label idLiquid_;
63 
64  //- Solid
65  label idSolid_;
66 
67 
68  // Mixture properties
69 
70  //- Phase component total fractions
71  scalarField YMixture0_;
72 
73 
74  // Private member functions
75 
76  //- Construct the indices and check correct specification of
77  // 1 gas, 1 liquid and 1 solid
78  void constructIds();
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("SingleMixtureFraction");
85 
86 
87  // Constructors
88 
89  //- Construct from dictionary
90  SingleMixtureFraction(const dictionary& dict, CloudType& owner);
91 
92 
93  //- Destructor
94  virtual ~SingleMixtureFraction();
95 
96 
97  // Member Functions
98 
99  // Access
100 
101  // Gas properties
102 
103  //- Return the list of gas mass fractions
104  const scalarField& YGas0() const;
105 
106  //- Return the total gas mass fraction
107  scalar YGasTot0() const;
108 
109 
110  // Liquid properties
111 
112  //- Return the list of liquid mass fractions
113  const scalarField& YLiquid0() const;
114 
115  //- Return the total liquid mass fraction
116  scalar YLiquidTot0() const;
117 
118 
119  // Solid properties
120 
121  //- Return the list of solid mass fractions
122  const scalarField& YSolid0() const;
123 
124  //- Return the total solid mass fraction
125  scalar YSolidTot0() const;
126 
127 
128  // Mixture properties
129 
130  //- Return the list of mixture mass fractions
131  virtual const scalarField& YMixture0() const;
132 
133  // Indices of gas, liquid and solid phases in phase properties
134  // list
135 
136  //- Gas id
137  virtual label idGas() const;
138 
139  //- Liquid id
140  virtual label idLiquid() const;
141 
142  //- Solid id
143  virtual label idSolid() const;
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #ifdef NoRepository
151 #endif
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #endif
160 
161 // ************************ vim: set sw=4 sts=4 et: ************************ //