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

Description
    Base class for methods to track resolved interfaces in a multiphase system.

    Determine the interface indicator field for a continuous phase i
    by determining the maximum contribution from interface pairs between
    phases i and j:

    \f[
        \mathrm{RI}_i = \mathrm{max}(\mathrm{RI}_{ij})\text{, where }i \neq j.
    \f]

SourceFiles
    interfaceIndicatorMethod.C

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

#ifndef interfaceIndicatorMethod_H
#define interfaceIndicatorMethod_H

#include "dictionary.H"
#include "runTimeSelectionTables.H"
#include "phaseModel.H"
#include "resolvedInterfaceSystem.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                   Class interfaceIndicatorMethod Declaration
\*---------------------------------------------------------------------------*/

class interfaceIndicatorMethod
:
    public regIOobject
{
protected:

    // Protected Data

        //- Reference to the resolvedInterfaceSystem
        const resolvedInterfaceSystem& resolvedInterface_;


    // Protected Member Functions

        //- Indicator field between a phase interface
        virtual tmp<volScalarField> interfaceIndicator
        (
            const phaseModel& phase1,
            const phaseModel& phase2
        ) const = 0;


public:

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


    // Declare runtime construction

        declareRunTimeSelectionTable
        (
            autoPtr,
            interfaceIndicatorMethod,
            dictionary,
            (
                const resolvedInterfaceSystem& resolvedInterface,
                const bool registerObject
            ),
            (resolvedInterface, registerObject)
        );


    // Constructors

        //- Construct from resolvedInterfaceSystem
        interfaceIndicatorMethod
        (
            const resolvedInterfaceSystem& resolvedInterface,
            const bool registerObject
        );


    //- Destructor
    virtual ~interfaceIndicatorMethod();


    // Selectors

        static autoPtr<interfaceIndicatorMethod> New
        (
            const resolvedInterfaceSystem& resolvedInterface,
            const bool registerObject=true
        );


    // Member Functions

        //- Indicator field of the proximity of a resolved phase interface
        //  Values are distributed from 0 (far) to 1 (near).
        virtual tmp<volScalarField> interfaceIndicator
        (
            const phaseModel& phase
        ) const;

        //- Dummy write for regIOobject
        bool writeData(Ostream& os) const;
};


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

} // End namespace Foam

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

#endif

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