basicMultiComponentMixture.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-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::basicMultiComponentMixture
26 
27 Description
28  Multi-component mixture.
29 
30  Provides a list of mass fraction fields and helper functions to
31  query mixture composition.
32 
33 SourceFiles
34  basicMultiComponentMixture.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef basicMultiComponentMixture_H
39 #define basicMultiComponentMixture_H
40 
41 #include "volFields.H"
42 #include "PtrList.H"
43 #include "speciesTable.H"
44 #include "typeInfo.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class basicMultiComponentMixture Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57 
58 protected:
59 
60  // Protected data
61 
62  //- Table of specie names
64 
65  //- Species mass fractions
67 
68 
69 public:
70 
71  //- Run time type information
72  TypeName("basicMultiComponentMixture");
73 
74 
75  //- The base class of the mixture
77 
78 
79  // Constructors
80 
81  //- Construct from dictionary, species names, mesh and phase name
83  (
84  const dictionary&,
85  const wordList& specieNames,
86  const fvMesh&,
87  const word&
88  );
89 
90 
91  //- Destructor
93  {}
94 
95 
96  // Member functions
97 
98  //- Return the table of species
99  inline const speciesTable& species() const;
100 
101  //- Return the mass-fraction fields
102  inline PtrList<volScalarField>& Y();
103 
104  //- Return the const mass-fraction fields
105  inline const PtrList<volScalarField>& Y() const;
106 
107  //- Return the mass-fraction field for a specie given by index
108  inline volScalarField& Y(const label i);
109 
110  //- Return the const mass-fraction field for a specie given by index
111  inline const volScalarField& Y(const label i) const;
112 
113  //- Return the mass-fraction field for a specie given by name
114  inline volScalarField& Y(const word& specieName);
115 
116  //- Return the const mass-fraction field for a specie given by name
117  inline const volScalarField& Y(const word& specieName) const;
118 
119  //- Does the mixture include this specie?
120  inline bool contains(const word& specieName) const;
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
PtrList< volScalarField > Y_
Species mass fractions.
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
TypeName("basicMultiComponentMixture")
Run time type information.
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
PtrList< volScalarField > & Y()
Return the mass-fraction fields.
basicMultiComponentMixture(const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
Construct from dictionary, species names, mesh and phase name.
speciesTable species_
Table of specie names.
A wordList with hashed indices for faster lookup by name.
bool contains(const word &specieName) const
Does the mixture include this specie?
const speciesTable & species() const
Return the table of species.
basicMultiComponentMixture basicMixtureType
The base class of the mixture.