regionModelFunctionObjectList.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2012 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::regionModelFunctionObjectList
 
Description
    List of cloud function objects
 
SourceFiles
    regionModelFunctionObjectListI.H
    regionModelFunctionObjectList.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef regionModelFunctionObjectList_H
#define regionModelFunctionObjectList_H
 
#include "PtrList.H"
#include "regionModelFunctionObject.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace regionModels
{
 
class regionModel;
 
/*---------------------------------------------------------------------------*\
                Class regionModelFunctionObjectList Declaration
\*---------------------------------------------------------------------------*/
 
class regionModelFunctionObjectList
:
    public PtrList<regionModelFunctionObject>
{
protected:
 
    // Protected Data
 
        //- Reference to the owner region model
        regionModel& owner_;
 
        //- Dictionary
        const dictionary dict_;
 
 
public:
 
    // Constructors
 
        //- Null constructor
        regionModelFunctionObjectList(regionModel& owner);
 
        //- Construct from mesh
        regionModelFunctionObjectList
        (
            regionModel& owner,
            const dictionary& dict,
            const bool readFields = true
        );
 
        //- Construct copy
        regionModelFunctionObjectList
        (
            const regionModelFunctionObjectList& rmfol
        );
 
 
    //- Destructor
    virtual ~regionModelFunctionObjectList();
 
 
    // Member Functions
 
        // Access
 
            //- Return const access to the cloud owner
            inline const regionModel& owner() const;
 
            //- Return refernce to the cloud owner
            inline regionModel& owner();
 
            //- Return the forces dictionary
            inline const dictionary& dict() const;
 
 
        // Evaluation
 
            //- Pre-evolve hook
            virtual void preEvolveRegion();
 
            //- Post-evolve hook
            virtual void postEvolveRegion();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace regionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "regionModelFunctionObjectListI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //