DeClercq.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) 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::packingDispersionModels::DeClercq
 
Description
    De Clercq packing dispersion model for waste water sludge
 
Usage
    Example usage:
    \verbatim
        packingDispersionModel DeClercq;
 
        DeClercqCoeffs
        {
            sigma0          8.022e-4;
            beta            2.3429e-3;
            alphaGel        4.5857e-3;
        }
    \endverbatim
 
SourceFiles
    DeClercq.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef DeClercq_H
#define DeClercq_H
 
#include "packingDispersionModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace packingDispersionModels
{
 
/*---------------------------------------------------------------------------*\
                           Class DeClercq Declaration
\*---------------------------------------------------------------------------*/
 
class DeClercq
:
    public packingDispersionModel
{
    // Private Data
 
        dimensionedScalar sigma0_;
        dimensionedScalar beta_;
        dimensionedScalar alphaGel_;
 
 
public:
 
    //- Runtime type information
    TypeName("DeClercq");
 
 
    // Constructors
 
        //- Construct from components
        DeClercq
        (
            const dictionary& dict,
            const relativeVelocityModel& relativeVelocity
        );
 
 
    //- Destructor
    ~DeClercq();
 
 
    // Member Functions
 
        //- Return the derivative of the packing stress w.r.t. phase-fraction
        virtual tmp<volScalarField> sigmaPrime() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace packingDispersionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //