/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | 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::dragModels::Syamlal

Description
    A drag model which accounts for the momentum transfer between distinct
    particulate phases due to collisions. Mainly used in dilute particle
    systems with collisional contacts.

    \verbatim
        Syamlal M. (1987).
        The Particle-Particle Drag Term in a Multiparticle Model of
        Fluidization, DOE/MC/21353-2373, DE87006500.
    \endverbatim

Usage
    \table
        Property      | Description             | Required  | Default value
        continuousPhase | Surrounding liquid    | yes       | -
        e             | Restitution coefficient | yes       | -
        Cf            | Friction coefficient    | yes       | -
    \endtable

    Example usage:
    \verbatim
    solid1_solid2
    {
        type            Syamlal;

        continuousPhase liquid;

        e               0.7;

        Cf              0.5;
    }
    \endverbatim

SourceFiles
    Syamlal.C

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

#ifndef Syamlal_H
#define Syamlal_H

#include "dragModel.H"

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

namespace Foam
{
namespace dragModels
{

/*---------------------------------------------------------------------------*\
                       Class Syamlal Declaration
\*---------------------------------------------------------------------------*/

class Syamlal
:
    public dragModel
{
    // Private Data

        //- Interface
        const phaseInterface interface_;

        //- Name of continuous phase
        const word continuousPhase_;

        //- Restitution coefficient
        const dimensionedScalar e_;

        //- Friction coefficient
        const dimensionedScalar Cf_;


public:

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


    // Constructors

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


    //- Destructor
    virtual ~Syamlal();


    // Member Functions

        //- The drag coefficient used in the momentum equation
        virtual tmp<volScalarField> K() const;

        //- The drag coefficient used in the face-momentum equations
        virtual tmp<surfaceScalarField> Kf() const;

};

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

} // End namespace dragModels
} // End namespace Foam

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

#endif

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