gravity.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) 2025-2026 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::Lagrangian::gravity
 
Description
    Gravity force model
 
Usage
    Example specification:
    \verbatim
    <LagrangianModelName>
    {
        type        gravity;
    }
    \endverbatim
 
SourceFiles
    gravity.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef gravity_H
#define gravity_H
 
#include "cloudLagrangianModel.H"
#include "dimensionedTypes.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace Lagrangian
{
 
/*---------------------------------------------------------------------------*\
                          Class gravity Declaration
\*---------------------------------------------------------------------------*/
 
class gravity
:
    public LagrangianModel,
    private cloudLagrangianModel
{
private:
 
    // Private Data
 
        //- Gravitational acceleration
        const dimensionedVector& g;
 
 
public:
 
    //- Runtime type information
    TypeName("gravity");
 
 
    // Constructors
 
        //- Construct from components
        gravity
        (
            const word& name,
            const LagrangianMesh& mesh,
            const dictionary& modelDict,
            const dictionary& stateDict
        );
 
 
    // Member Functions
 
        //- Return the name of the velocity field
        virtual wordList addSupFields() const;
 
        //- Return true for the velocity field
        virtual bool addsSupToField
        (
            const word& fieldName,
            const word& eqnFieldName
        ) const;
 
        //- Add a source term to the velocity equation
        virtual void addSup
        (
            const LagrangianSubScalarField& deltaT,
            const LagrangianSubVectorSubField& U,
            LagrangianEqn<vector>& eqn
        ) const;
 
        //- Add a source term to the momentum equation
        virtual void addSup
        (
            const LagrangianSubScalarField& deltaT,
            const LagrangianSubScalarSubField& vOrM,
            const LagrangianSubVectorSubField& U,
            LagrangianEqn<vector>& eqn
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Lagrangian
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //