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

Description
    Morphology transfer model returning a mass transfer rate from a dispersed
    phase to a continuous phase with identical physical properties. This change
    is triggered by a threshold value for the sum of both morphology phase
    fractions, i.e. the transfer from disperse to continuous is active as long
    as alphaDisperse + alphaContinuous >= alphaThreshold is true.

    Additional phases can be taken into account when computing the phase
    fraction threshold. This typically makes sense in case of multiple velocity
    groups (represented by disperse phases).

    The transfer can be restricted to regions where the continuous phase already
    exists, for example to restrict it to continuous interfaces. Another option
    to locally restrict the transfer is to provide the name of an existing
    field which us used as a mask. The transfer is then only allowed in cells
    where the mask field is positive.

Usage
    \table
        Property       | Description                | Required | Default
        alphaThreshold | Critical phase fraction sum | no | continuousThreshold
        continuousMin  | Minimum amount of continuous phase | no | 0
        otherPhases    | List of other phases taken into account | no | none
        mask           | Name of field for masking transfer | no | none
    \endtable

See also
    Foam::fv::morphologyTransferModel

SourceFiles
    accumulationToContinuous.C

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

#ifndef accumulationToContinuous_H
#define accumulationToContinuous_H

#include "morphologyTransferModel.H"

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

namespace Foam
{

namespace fv
{

/*---------------------------------------------------------------------------*\
                Class accumulationToContinuous Declaration
\*---------------------------------------------------------------------------*/

class accumulationToContinuous
:
    public morphologyTransferModel
{
    // Private Data

        //- Disperse member of phase interface
        const phaseModel& disperse_;

        //- Continuous member of phase interface
        const phaseModel& continuous_;

        //- Threshold for volume fraction
        const dimensionedScalar alphaThreshold_;

        //- Minimum amount of target phase
        const dimensionedScalar continuousMin_;

        //- Names of other phases to consider for phase fraction sum
        const wordList otherPhases_;

        //- Mask field name
        const word maskName_;


public:

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


    // Constructors

        //- Construct from components
        accumulationToContinuous
        (
            const dictionary& dict,
            const dispersedPhaseInterface& interface
        );


    //- Destructor
    virtual ~accumulationToContinuous();


    // Member Functions

        //- Mass transfer rate
        virtual tmp<volScalarField::Internal> dmdtf() const;
};


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

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

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

#endif

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