src/thermophysicalModels/solidMixture/solidMixture/solidMixture.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::solidMixture
  27
  28 Description
  29     Foam::solidMixture
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef solidMixture_H
  34 #define solidMixture_H
  35
  36 #include "scalarField.H"
  37 #include "PtrList.H"
  38 #include "solid.H"
  39 #include "autoPtr.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                          Class solidMixture Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class solidMixture
  51 {
  52
  53     // Private data
  54
  55         //- The names of the solids
  56         List<word> components_;
  57
  58         //- The solid properties
  59         PtrList<solid> properties_;
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct from dictionary
  67         solidMixture
  68         (
  69             const dictionary&
  70         );
  71
  72
  73     // Selectors
  74
  75         //- Select construct from dictionary
  76         static autoPtr<solidMixture> New
  77         (
  78             const dictionary&
  79         );
  80
  81
  82     // Member Functions
  83
  84         //- Return the sold names
  85         inline const List<word>& components() const
  86         {
  87             return components_;
  88         }
  89
  90         //- Return the solid properties
  91         inline const PtrList<solid>& properties() const
  92         {
  93             return properties_;
  94         }
  95
  96         //- Returns the mass fractions, given mole fractions
  97         scalarField Y(const scalarField& X) const;
  98
  99         //- Returns the mole fractions, given mass fractions
 100         scalarField X(const scalarField& Y) const;
 101
 102         //- Calculate the mixture density [kg/m^3] as a function of
 103         //  volume fractions
 104         scalar rho
 105         (
 106             const scalarField& X
 107         ) const;
 108
 109         //- Calculate the mixture heat capacity [J/(kg K)] as a function
 110         //  of mass fractions
 111         scalar cp
 112         (
 113             const scalarField& Y
 114         ) const;
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //