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

Description
    Class to represent a interface between phases where the two phases are
    considered to be segregated; that is, separated by a geometrically complex
    interface for which dispersed representations are inappropriate.

SourceFiles
    segregatedPhaseInterface.C

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

#ifndef segregatedPhaseInterface_H
#define segregatedPhaseInterface_H

#include "phaseInterface.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                   Class segregatedPhaseInterface Declaration
\*---------------------------------------------------------------------------*/

class segregatedPhaseInterface
:
    virtual public phaseInterface
{
protected:

    // Protected Member Functions

        //- Return true if the phase interfaces are the same
        virtual bool same(const phaseInterface& interface, bool strict) const;


public:

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


    // Constructors

        //- Construct from phases
        segregatedPhaseInterface
        (
            const phaseModel& phase1,
            const phaseModel& phase2
        );

        //- Construct from fluid and name
        segregatedPhaseInterface
        (
            const phaseSystem& fluid,
            const word& name
        );


    //- Destructor
    virtual ~segregatedPhaseInterface();


    // Static Member Functions

        //- Return the separator that delimits this interface's name
        static word separator()
        {
            return "segregatedWith";
        }


    // Member Functions

        //- Name
        virtual word name() const;


//~~~~~~~~~~~~~~~~~~~~~~~~~~~ Begin Code Repository ~~~~~~~~~~~~~~~~~~~~~~~~~//
    // Properties

        //- Return the interfacial area density
        tmp<volScalarField> Ai() const;

        //- Return the interface gradient between two phases
        tmp<volVectorField> gradAlpha() const;

        //- Return the interface gradient flux between two phases
        tmp<surfaceScalarField> gradAlphaf() const;

        //- Return the interface normal vector between two phases
        tmp<volVectorField> nHat() const;

        //- Return the face-based interface normal vector between two phases
        tmp<surfaceVectorField> nHatfv() const;

        //- Return the face-based interface normal between two phases dotted
        //  with face areas
        tmp<surfaceScalarField> nHatf() const;

        //- Return the interface normal vector across the interface
        const volVectorField& gradAlphaI() const;

        //- Return the relative velocity across the interface
        const volVectorField& UrI() const;

        //- Return the shear stress magnitude across the interface
        const volScalarField& tauI() const;

        //- Return the interface curvature
        tmp<volScalarField> K() const;

        //- Return the degree of under resolution
        const volScalarField& underResolution() const;
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~ End Code Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~//
};


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

} // End namespace Foam

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

#endif

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