/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | Multiphase Code Repository by HZDR
  ======   //   ||  || ===//   | Website: https://doi.org/10.14278/rodare.767
  ||  ||  //    ||  // || \\   | License: GPL-3.0-or-later
  ==  == ====== ====   ==  ==  |
-------------------------------------------------------------------------------
License
    This file is part of the Multiphase Code Repository by HZDR.

    Copyright (C) 2025 by Helmholtz-Zentrum Dresden-Rossendorf e.V. (HZDR),
    Website: https://hzdr.de

    Multiphase Code Repository by HZDR is based on the free software for
    computational fluid dynamics (CFD) from the OpenFOAM Foundation.
    Copyright (C) 2025 by OpenFOAM Foundation, Website: https://openfoam.org

    If you are interested in which files are original OpenFOAM Foundation
    files, which OpenFOAM Foundation files were modified, and which files were
    newly created, see FILES.md.

    Multiphase Code Repository by HZDR 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.

    Multiphase Code Repository by HZDR 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 the Multiphase Code Repository by HZDR. If not, see
    <http://www.gnu.org/licenses/>.

Class
    Foam::liftModels::Hessenkemper

Description
    Lift model of Hessenkemper et al. (2021).

    Note that the dimensionless shear rate Sr is computed as described in
    Shi and Rzehak (2019).

    As the model applies only for bubble diameters<7mm and does not limit
    lift coefficient values beyond that for larger bubbles, an optional clipping
    via minimumCl parameter is introduced.

    Note that in addition the modified Eo number is given an upper limit of 183
    since it was found that function G cannot handle values larger than that.

    References:
    \verbatim
        Hessenkemper, H., Ziegenhein, T., Rzehak, R., Lucas, D.,
        & Tomiyama, A. (2021).
        Lift force coefficient of ellipsoidal single bubbles in water.
        International Journal of Multiphase Flow, 138, 103587.
    \endverbatim

    \verbatim
        Shi, P., & Rzehak, R. (2019).
        Lift forces on Solid Spherical Particles in Unbounded Flows.
        Chemical Engineering Science, 208, 115145.
    \endverbatim

Usage
    \table
        Property   | Description                    | Required | Default value
        residualRe | minimum Reynolds number        | no       | 1e-1
        minimumCl  | lower limit for Cl coefficient | no       | -vGreat
    \endtable

SourceFiles
    Hessenkemper.C

\*---------------------------------------------------------------------------*/

#ifndef Hessenkemper_H
#define Hessenkemper_H

#include "dispersedLiftModel.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

class aspectRatioModel;

namespace liftModels
{

/*---------------------------------------------------------------------------*\
                        Class Hessenkemper Declaration
\*---------------------------------------------------------------------------*/

class Hessenkemper
:
    public dispersedLiftModel
{
    // Private Data

        //- The aspect ratio model
        autoPtr<aspectRatioModel> aspectRatio_;

        //- Residual Reynolds number
        const dimensionedScalar residualRe_;

        //- Minimum lift coefficient
        const dimensionedScalar minimumCl_;

public:

    //- Runtime type information
    TypeName("Hessenkemper");


    // Constructors

        //- Construct from a dictionary and an interface
        Hessenkemper
        (
            const dictionary& dict,
            const phaseInterface& interface
        );


    //- Destructor
    virtual ~Hessenkemper();


    // Member Functions

        //- Lift coefficient
        virtual tmp<volScalarField> Cl() const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace liftModels
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
