/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::CMC::FlameStructure

Description

SourceFiles
    FlameStructureI.H
    FlameStructure.C
    FlameStructureIO.C

\*---------------------------------------------------------------------------*/

#ifndef FlameStructure_H
#define FlameStructure_H

#include "scalarField.H"
#include "hashedWordList.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of classes
class Istream;
class Ostream;

namespace CMC
{
class FlameStructure;
}

// Forward declaration of friend functions and operators
Istream& operator>>(Istream&, CMC::FlameStructure&);
Ostream& operator<<(Ostream&, const CMC::FlameStructure&);

namespace CMC
{

/*---------------------------------------------------------------------------*\
                         Class FlameStructure Declaration
\*---------------------------------------------------------------------------*/

class FlameStructure
{
    // Private data

        //- Mixture fraction grid
        scalarField eta_;

        //- Species name table
        hashedWordList names_;

        //- Species mass fraction
        PtrList<scalarField> Y_;
        // scalarFieldArray2d Y_;

        //- Species production rate
        PtrList<scalarField> W_;
        //scalarFieldArray2d W_;

        //- Temperature
        scalarField T_;

        //- Heat source
        scalarField Q_;

        //- Enthalpy
        scalarField h_;

        //- Density
        scalarField rho_;

        //- Specific gas constant for mean W
        scalarField Rgas_;


    // Private Member Functions

        //- Disallow Construct null
        FlameStructure();

        //- Disallow default bitwise copy construct
        FlameStructure(const FlameStructure&);

        //- Disallow default bitwise assignment
        void operator=(const FlameStructure&);

        //- limit value of alpha and beta
        void limitAB();


public:

    // Static data members

        //- Static data staticData
        // static const dataType staticData;


    // Constructors

        //- Construct from components
        FlameStructure(word fileName);

        //- Construct from Istream
        FlameStructure(Istream&);

        //- Construct as copy
        // FlameStructure(const FlameStructure&);


    // Selectors

        //- Select null constructed
        // static autoPtr<FlameStructure> New();


    //- Destructor
    ~FlameStructure();


    // Member Functions

        // Access

            //- Select null constructed
            scalarField& eta() {return eta_;}

            //- Select null constructed
            hashedWordList& names() {return names_;}

            //- Select null constructed
            PtrList<scalarField>& Y() {return Y_;}

            //- Select null constructed
            PtrList<scalarField>& W() {return W_;}

            //- Select null constructed
            scalarField& T() {return T_;}

            //- Select null constructed
            scalarField& Q() {return Q_;}

            //- Select null constructed
            scalarField& rho() {return rho_;}

            //- Select null constructed
            scalarField& h() {return h_;}

            //- Select null constructed
            scalarField& Rgas() {return Rgas_;}

            //- Select null constructed
            const scalarField& eta() const {return eta_;}

            //- Select null constructed
            const hashedWordList& names() const {return names_;}

            //- Select null constructed
            const PtrList<scalarField>& Y() const {return Y_;}

            //- Select null constructed
            const PtrList<scalarField>& W() const {return W_;}

            //- Select null constructed
            const scalarField& T() const {return T_;}

            //- Select null constructed
            const scalarField& Q() const {return Q_;}

            //- Select null constructed
            const scalarField& rho() const {return rho_;}

            //- Select null constructed
            const scalarField& h() const {return h_;}

            //- Select null constructed
            const scalarField& Rgas() const {return Rgas_;}
    /*
    */

        // Check

        // Edit

        // Write


    // Member Operators

        // void operator=(const FlameStructure&);


    // Friend Functions

    // Friend Operators

    // IOstream Operators

        friend Istream& ::Foam::operator>>(Istream&, FlameStructure&);
        friend Ostream& ::Foam::operator<<(Ostream&, const FlameStructure&);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace CMC
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "FlameStructureI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
