porosityForce.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2012-2024 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::fv::porosityForce
 
Description
    This model applies the force exerted on the fluid by a porous media
 
Usage
    Example usage, here employing the Darcy-Forchheimer model:
    \verbatim
    porosityForceCoeffs
    {
        type            DarcyForchheimer;
 
        DarcyForchheimerCoeffs
        {
            d   d [0 -2 0 0 0 0 0] (5e7 -1000 -1000);
            f   f [0 -1 0 0 0 0 0] (0 0 0);
 
            coordinateSystem
            {
                type    cartesian;
                origin  (0 0 0);
                coordinateRotation
                {
                    type    axesRotation;
                    e1  (0.70710678 0.70710678 0);
                    e2  (0 0 1);
                }
            }
        }
    }
    \endverbatim
 
    Note:
        The porous region must be selected as a cellZone.
 
SourceFiles
    porosityForce.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef porosityForce_H
#define porosityForce_H
 
#include "fvModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
class porosityModel;
 
namespace fv
{
 
/*---------------------------------------------------------------------------*\
                   Class porosityForce Declaration
\*---------------------------------------------------------------------------*/
 
class porosityForce
:
    public fvModel
{
    // Private data
 
        //- Names of the velocity fields
        wordList UNames_;
 
        //- Run-time selectable porosity model
        mutable autoPtr<porosityModel> porosityPtr_;
 
 
    // Private Member Functions
 
        //- Reset the porosity model
        //  during construction, re-reading and mesh-change
        void reset();
 
        //- Non-virtual read
        void readCoeffs();
 
 
public:
 
    //- Runtime type information
    TypeName("porosityForce");
 
 
    // Constructors
 
        //- Construct from components
        porosityForce
        (
            const word& name,
            const word& modelType,
            const fvMesh& mesh,
            const dictionary& dict
        );
 
        //- Disallow default bitwise copy construction
        porosityForce(const porosityForce&) = delete;
 
 
    //- Destructor
    virtual ~porosityForce()
    {}
 
 
    // Member Functions
 
        // Access
 
            //- Return the porosity model
            const porosityModel& model() const
            {
                return porosityPtr_();
            }
 
 
        // Checks
 
            //- Return the list of fields for which the fvModel adds source term
            //  to the transport equation
            virtual wordList addSupFields() const;
 
 
        // Add explicit and implicit contributions
 
            //- Add implicit contribution to momentum equation
            virtual void addSup
            (
                const volVectorField& U,
                fvMatrix<vector>& eqn
            ) const;
 
            //- Add implicit contribution to compressible momentum equation
            virtual void addSup
            (
                const volScalarField& rho,
                const volVectorField& U,
                fvMatrix<vector>& eqn
            ) const;
 
            //- Add implicit contribution to phase momentum equation
            virtual void addSup
            (
                const volScalarField& alpha,
                const volScalarField& rho,
                const volVectorField& U,
                fvMatrix<vector>& eqn
            ) const;
 
 
        // Mesh changes
 
            //- Update for mesh motion
            virtual bool movePoints();
 
            //- Update topology using the given map
            virtual void topoChange(const polyTopoChangeMap&);
 
            //- Update from another mesh using the given map
            virtual void mapMesh(const polyMeshMap&);
 
            //- Redistribute or update using the given distribution map
            virtual void distribute(const polyDistributionMap&);
 
 
        // IO
 
            //- Read dictionary
            virtual bool read(const dictionary& dict);
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const porosityForce&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace fv
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //