solidMixtureProperties.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::solidMixtureProperties
 
Description
    A mixture of solids
 
    An example of a two component solid mixture:
    \verbatim
        <parentDictionary>
        {
            C;
 
            ash
            {
                //... user defined properties for ash
            }
        }
    \endverbatim
 
 
SourceFiles
    solidMixtureProperties.C
 
See also
    Foam::solidProperties
 
\*---------------------------------------------------------------------------*/
 
#ifndef solidMixtureProperties_H
#define solidMixtureProperties_H
 
#include "solidProperties.H"
#include "PtrList.H"
#include "scalarField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class solidMixtureProperties Declaration
\*---------------------------------------------------------------------------*/
 
class solidMixtureProperties
{
    // Private data
 
        //- The names of the solids
        List<word> components_;
 
        //- The solidProperties properties
        PtrList<solidProperties> properties_;
 
 
public:
 
    // Constructors
 
        //- Construct from dictionary
        solidMixtureProperties(const dictionary&);
 
        //- Construct copy
        solidMixtureProperties(const solidMixtureProperties& lm);
 
        //- Construct and return a clone
        virtual autoPtr<solidMixtureProperties> clone() const
        {
            return autoPtr<solidMixtureProperties>::New(*this);
        }
 
 
    //- Destructor
    virtual ~solidMixtureProperties() = default;
 
 
    // Selectors
 
        //- Select construct from dictionary
        static autoPtr<solidMixtureProperties> New(const dictionary&);
 
 
    // Member Functions
 
        //- Return the solidProperties names
        inline const List<word>& components() const
        {
            return components_;
        }
 
        //- Return the solidProperties properties
        inline const PtrList<solidProperties>& properties() const
        {
            return properties_;
        }
 
        //- Return the number of solids in the mixture
        inline label size() const
        {
            return components_.size();
        }
 
        //- Calculate the mixture density [kg/m^3] as a function of
        //  mass fractions
        scalar rho(const scalarField& Y) const;
 
        //- Calculate the mixture heat capacity [J/(kg K)] as a function of
        //  mass fractions
        scalar Cp(const scalarField& Y) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //