pyrolysisModelCollection.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-2014 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::regionModels::pyrolysisModels::pyrolysisModelCollection
 
Description
    A centralized pyrolysis collection.
 
    Container class for a set of pyrolysis with functions implemented
    to loop over the functions for each type.
 
SourceFiles
    pyrolysisModelCollection.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef pyrolysisModelCollection_H
#define pyrolysisModelCollection_H
 
#include "PtrList.H"
#include "pyrolysisModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward class declarations
class fvMesh;
 
namespace regionModels
{
namespace pyrolysisModels
{
 
/*---------------------------------------------------------------------------*\
                  Class pyrolysisModelCollection Declaration
\*---------------------------------------------------------------------------*/
 
class pyrolysisModelCollection
:
    public PtrList<pyrolysisModel>
{
    // Private Member Functions
 
        //- No copy construct
        pyrolysisModelCollection(const pyrolysisModelCollection&) = delete;
 
        //- No copy assignment
        void operator=(const pyrolysisModelCollection&) = delete;
 
 
public:
 
    // Runtime type information
    TypeName("pyrolysisModelCollection");
 
 
    // Constructors
 
        //- Construct from mesh
        pyrolysisModelCollection(const fvMesh&);
 
 
    //- Destructor
    virtual ~pyrolysisModelCollection();
 
 
    // Member Functions
 
        //- Pre-evolve regions
        virtual void preEvolveRegion();
 
        //- Evolve the pyrolysis equation regions
        virtual void evolveRegion();
 
        //- Evolve regions
        virtual void evolve();
 
        //- Provide some feedback from pyrolysis regions
        virtual void info();
 
        //- Return max diffusivity allowed in the solid
        virtual scalar maxDiff() const;
 
        //- Mean diffusion number of the solid regions
        virtual scalar solidRegionDiffNo() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace pyrolysisModels
} // End namespace regionModels
} // End namespace Foam
 
 
#endif
 
// ************************************************************************* //