porousModel.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) 2017-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::porousModel
 
Description
 
SourceFiles
    porousModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef porousModel_H
#define porousModel_H
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "volFields.H"
#include "dictionary.H"
#include "runTimeSelectionTables.H"
 
namespace Foam
{
 
// Forward Declarations
class fvMesh;
 
/*---------------------------------------------------------------------------*\
                         Class porousModel Declaration
\*---------------------------------------------------------------------------*/
 
class porousModel
:
    public regIOobject
{
protected:
 
    // Protected Data
 
        //- Reference to mesh
        const fvMesh& mesh_;
 
 
public:
 
    //- Runtime type information
    TypeName("porousModel");
 
 
    // Declare runtime construction
    declareRunTimeSelectionTable
    (
        autoPtr,
        porousModel,
        dictionary,
        (
            const dictionary& dict,
            const fvMesh& mesh
        ),
        (dict, mesh)
    );
 
 
    // Constructors
 
        //- Construct from a dictionary and mesh
        porousModel
        (
            const dictionary& dict,
            const fvMesh& mesh
        );
 
 
    //- Destructor
    virtual ~porousModel() = default;
 
 
    // Selectors
 
        static autoPtr<porousModel> New
        (
            const dictionary& dict,
            const fvMesh& mesh
        );
 
 
    // Member Functions
 
        //- Momentum source
        virtual  tmp<volScalarField> S() const = 0;
 
        //- Dummy write for regIOobject
        bool writeData(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //