/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | 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::populationBalance::binaryBreakupModels::Liao

Description
    Bubble breakup model of Liao et al. (2015). The terminal velocities and drag
    coefficients are computed by an iterative procedure based on the drag model
    of Ishii and Zuber (1979) at the beginning of the simulation, assuming
    single bubbles rising in quiescent liquid.

    References:
    \verbatim
        Liao, Y.; Rzehak, R.; Lucas, D.; Krepper, E. (2015).
        Baseline closure models for dispersed bubbly flow: Bubble coalescence
        and breakup.
        Chemical Engineering Science, 122, 336-349.

        Ishii, M., & Zuber, N. (1979).
        Drag coefficient and relative velocity in bubbly, droplet or particulate
        flows.
        AIChE Journal, 25(5), 843-855.
    \endverbatim

Usage
    \table
        Property           | Description              | Required | Default value
        BTurb              | coefficient BTurb        | no       | 1.0
        BShear             | coefficient Bbuoy        | no       | 1.0
        BEddy              | coefficient BEddy        | no       | 1.0
        BFric              | coefficient Bwake        | no       | 1.0
        turbulence         | Switch for turbulence    | yes      | none
        laminarShear       | Switch for laminar shear | yes      | none
        turbulentShear     | Switch for eddies        | yes      | none
        interfacialFriction| Switch for friction      | yes      | none
    \endtable

SourceFiles
    Liao.C

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

#ifndef Liao_H
#define Liao_H

#include "binaryBreakupModel.H"
#include "LiaoBase.H"

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

namespace Foam
{
namespace populationBalance
{
namespace binaryBreakupModels
{

/*---------------------------------------------------------------------------*\
                            Class Liao Declaration
\*---------------------------------------------------------------------------*/

class Liao
:
    public binaryBreakupModel,
    public LiaoBase
{
    // Private Data

        //- Disambiguate the population balance reference
        using binaryBreakupModel::popBal_;

        //- Optional coefficient BTurb
        dimensionedScalar BTurb_;

        //- Optional coefficient BShear
        dimensionedScalar BShear_;

        //- Optional coefficient BEddy
        dimensionedScalar BEddy_;

        //- Optional coefficient BFric
        dimensionedScalar BFric_;

        //- Switch for considering turbulent velocity fluctuation
        Switch turbulence_;

        //- Switch for considering velocity gradients in the bulk
        Switch laminarShear_;

        //- Switch for considering eddies
        Switch turbulentShear_;

        //- Switch for considering interfacial friction
        Switch interfacialFriction_;


public:

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

    // Constructor

        Liao
        (
            const populationBalanceModel& popBal,
            const dictionary& dict
        );


    //- Destructor
    virtual ~Liao()
    {}


    // Member Functions

        //- Precompute diameter independent expressions
        virtual void precompute();

        //- Add to binary breakupRate
        virtual void addToBinaryBreakupRate
        (
            volScalarField::Internal& binaryBreakupRate,
            const label i,
            const label j
        );
};


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

} // End namespace binaryBreakupModels
} // End namespace populationBalance
} // End namespace Foam

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

#endif

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