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

Description
    Abstract base class for decontamination modeling.

SourceFiles
    decontaminationModel.C

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

#ifndef decontaminationModel_H
#define decontaminationModel_H

#include "rhoFluidMulticomponentThermo.H"
#include "dispersedPhaseInterface.H"

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

namespace Foam
{

namespace fv
{

/*---------------------------------------------------------------------------*\
                    Class decontaminationModel Declaration
\*---------------------------------------------------------------------------*/

class decontaminationModel
{
protected:

    // Protected Data

        //- Interface
        const dispersedPhaseInterface interface_;

        //- Const reference to the gas phase
        const phaseModel& gasPhase_;

        //- Residual value of alpha of the gas phase below which no mass
        //  transfer takes place
        const dimensionedScalar residualAlpha_;

        //- gas phase thermo model
        const rhoFluidMulticomponentThermo& thermo_;

        //- List of species to return for decontamination fvModel
        const hashedWordList& species_;

        //- The name of the carrier specie
        const word carrierSpecie_;

        //- Index of carrier specie in gas phase
        const label indexC_;

        //- Index of the specie being transferred from the gas phase
        const label indexI_;

        //- Particle volume fraction in the gas phase
        mutable volScalarField particleVolumeFraction_;


    // Protected Member Functions
        //- Decontamination rate
        virtual tmp<volScalarField> rate() const = 0;


public:

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


    // Declare runtime construction

        declareRunTimeSelectionTable
        (
            autoPtr,
            decontaminationModel,
            dictionary,
            (
                const dictionary& dict,
                const dispersedPhaseInterface& interface,
                const hashedWordList& species
            ),
            (dict, interface, species)
        );


    // Constructors

        //- Construct from a dictionary and an interface
        decontaminationModel
        (
            const dictionary& dict,
            const dispersedPhaseInterface& interface,
            const hashedWordList& species
        );


    //- Destructor
    virtual ~decontaminationModel();


    // Selectors

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


    // Member Functions

        //- The list of individual species that are transferred
        virtual const hashedWordList& species() const;

        //- The mass transfer rate for transferred specie
        virtual tmp<volScalarField::Internal> dmidtf() const;
};


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

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

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

#endif

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