/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | 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::fv::inducedTurbulenceModel

Description
    Model for turbulence induced by a dispersed phase

SourceFiles
    inducedTurbulenceModel.C
    inducedTurbulenceModelNew.C

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

#ifndef inducedTurbulenceModel_H
#define inducedTurbulenceModel_H

#include "volFields.H"
#include "runTimeSelectionTables.H"
#include "dispersedDragModel.H"
#include "phaseCompressibleMomentumTransportModels.H"

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

namespace Foam
{
namespace fv
{

/*---------------------------------------------------------------------------*\
                   Class inducedTurbulenceModel Declaration
\*---------------------------------------------------------------------------*/

class inducedTurbulenceModel
{
protected:

    // Protected Data

        //- Dispersed phase interface
        const dispersedPhaseInterface& interface_;

        //- Reference to drag model for dispersed phase interface
        const dragModels::dispersedDragModel& dispersedDragModel_;

        //- Reference to continuous phase turbulence model
        const phaseCompressible::momentumTransportModel& turbulence_;

        //- Reference to model dictionary
        const dictionary& dict_;

        // Turbulence model coefficients

            mutable autoPtr<dimensionedScalar> betaStar_;


public:

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


    // Declare runtime construction

        declareRunTimeSelectionTable
        (
            autoPtr,
            inducedTurbulenceModel,
            dictionary,
            (
                const dictionary& dict,
                const dispersedPhaseInterface& interface
            ),
            (dict, interface)
        );


    // Constructors

        //- Construct from dictionary and dispersed phase interface
        inducedTurbulenceModel
        (
            const dictionary& dict,
            const dispersedPhaseInterface& interface
        );


    //- Destructor
    virtual ~inducedTurbulenceModel();


    // Selectors

        //- Select from dictionary and mesh
        static autoPtr<inducedTurbulenceModel> New
        (
            const dictionary& dict,
            const dispersedPhaseInterface& interface
        );


    // Member Functions

        const dispersedPhaseInterface& interface() const
        {
            return interface_;
        }

        //- Return coefficient for turbulent kinetic energy source
        virtual tmp<volScalarField> Ck() const = 0;

        //- Return coefficient for turbulent dissipation rate source
        virtual tmp<volScalarField> Ceps() const = 0;

        //- Return turbulent kinetic energy source
        virtual tmp<volScalarField> kSource() const;

        //- Return turbulent dissipation rate source
        virtual tmp<volScalarField> epsilonSource() const;

        //- Return turbulent eddy frequency source
        virtual tmp<fvScalarMatrix> omegaSource(fvScalarMatrix& eqn) const;
};


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

} // End namespace fv
} // End namespace Foam

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

#endif

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