FreeFOAM The Cross-Platform CFD Toolkit
solidMixture.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) 1991-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::solidMixture
26 
27 Description
28  Foam::solidMixture
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef solidMixture_H
33 #define solidMixture_H
34 
35 #include <OpenFOAM/scalarField.H>
36 #include <OpenFOAM/PtrList.H>
37 #include <solids/solid.H>
38 #include <OpenFOAM/autoPtr.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class solidMixture Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51 
52  // Private data
53 
54  //- The names of the solids
55  List<word> components_;
56 
57  //- The solid properties
58  PtrList<solid> properties_;
59 
60 
61 public:
62 
63  // Constructors
64 
65  //- Construct from dictionary
67  (
68  const dictionary&
69  );
70 
71 
72  // Selectors
73 
74  //- Select construct from dictionary
76  (
77  const dictionary&
78  );
79 
80 
81  // Member Functions
82 
83  //- Return the sold names
84  inline const List<word>& components() const
85  {
86  return components_;
87  }
88 
89  //- Return the solid properties
90  inline const PtrList<solid>& properties() const
91  {
92  return properties_;
93  }
94 
95  //- Returns the mass fractions, given mole fractions
96  scalarField Y(const scalarField& X) const;
97 
98  //- Returns the mole fractions, given mass fractions
99  scalarField X(const scalarField& Y) const;
100 
101  //- Calculate the mixture density [kg/m^3] as a function of
102  // volume fractions
103  scalar rho
104  (
105  const scalarField& X
106  ) const;
107 
108  //- Calculate the mixture heat capacity [J/(kg K)] as a function
109  // of mass fractions
110  scalar cp
111  (
112  const scalarField& Y
113  ) const;
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************ vim: set sw=4 sts=4 et: ************************ //