/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM 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.

    OpenFOAM 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 OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::fvModel

Description
    Finite volume model abstract base class.

SourceFiles
    fvModel.C

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

#ifndef fvModel_H
#define fvModel_H

#include "fvMatricesFwd.H"
#include "volFieldsFwd.H"
#include "dictionary.H"
#include "dimensionSet.H"
#include "HashSet.H"
#include "fvModelM.H"
#include "geometricOneField.H"

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

namespace Foam
{

class fvMesh;
class polyTopoChangeMap;
class polyMeshMap;
class polyDistributionMap;

/*---------------------------------------------------------------------------*\
                           Class fvModel Declaration
\*---------------------------------------------------------------------------*/

class fvModel
{
    // Private Data

        //- Model name
        const word name_;

        //- Model type
        const word modelType_;

        //- Reference to the mesh database
        const fvMesh& mesh_;


protected:

    // Protected Member Functions

        //- Add a source term to an equation
        template<class Type>
        void addSupType
        (
            const VolField<Type>& field,
            fvMatrix<Type>& eqn
        ) const;

        //- Add a source term to a compressible equation
        template<class Type>
        void addSupType
        (
            const volScalarField& rho,
            const VolField<Type>& field,
            fvMatrix<Type>& eqn
        ) const;

        //- Add a source term to a phase equation
        template<class Type>
        void addSupType
        (
            const volScalarField& alpha,
            const volScalarField& rho,
            const VolField<Type>& field,
            fvMatrix<Type>& eqn
        ) const;

        //- Return a source for an equation
        template<class Type, class ... AlphaRhoFieldTypes>
        tmp<fvMatrix<Type>> sourceTerm
        (
            const VolField<Type>& eqnField,
            const dimensionSet& ds,
            const AlphaRhoFieldTypes& ... alphaRhoFields
        ) const;


public:

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


    //- The keywords read by this class
    static const wordHashSet keywords;


    // Declare run-time constructor selection table

        declareRunTimeSelectionTable
        (
            autoPtr,
            fvModel,
            dictionary,
            (
                const word& name,
                const word& modelType,
                const fvMesh& mesh,
                const dictionary& dict
            ),
            (name, modelType, mesh, dict)
        );


    // Static Member Functions

        //- Return the coefficients sub-dictionary for a given model type
        inline static const dictionary& coeffs
        (
            const word& modelType,
            const dictionary&
        );

        //- Return the dimensions of the matrix of a source term
        template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
        static dimensionSet sourceDims
        (
            const dimensionSet& ds,
            const AlphaRhoFieldType& alphaRhoField,
            const AlphaRhoFieldTypes& ... alphaRhoFields
        );

        //- Return the dimensions of the matrix of a source term (base
        //  condition for the above)
        inline static const dimensionSet& sourceDims(const dimensionSet& ds);

        //- Return the name of the field associated with a source term
        template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
        static const word& fieldName
        (
            const AlphaRhoFieldType& alphaRhoField,
            const AlphaRhoFieldTypes& ... alphaRhoFields
        );

        //- Return the name of the field associated with a source term (base
        //  condition for the above)
        template<class AlphaRhoFieldType>
        static const word& fieldName(const AlphaRhoFieldType& alphaRhoField);

        //- Return the name of the field associated with a source term. Special
        //  overload for volume sources with no associated field.
        static const word& fieldName();


    // Constructors

        //- Construct from components
        fvModel
        (
            const word& name,
            const word& modelType,
            const fvMesh& mesh,
            const dictionary& dict
        );

        //- Return clone
        autoPtr<fvModel> clone() const
        {
            NotImplemented;
            return autoPtr<fvModel>(nullptr);
        }

        //- Return pointer to new fvModel object created
        //  on the freestore from an Istream
        class iNew
        {
            //- Reference to the mesh
            const fvMesh& mesh_;

            const word& name_;

        public:

            iNew
            (
                const fvMesh& mesh,
                const word& name
            )
            :
                mesh_(mesh),
                name_(name)
            {}

            autoPtr<fvModel> operator()(Istream& is) const
            {
                // const word name(is);
                const dictionary dict(is);

                return autoPtr<fvModel>
                (
                    fvModel::New(name_, mesh_, dict)
                );
            }
        };


    // Selectors

        //- Return a reference to the selected fvModel
        static autoPtr<fvModel> New
        (
            const word& name,
            const fvMesh& mesh,
            const dictionary& dict
        );


    //- Destructor
    virtual ~fvModel();


    // Member Functions

        // Access

            //- Return const access to the source name
            inline const word& name() const;

            //- Return name as the keyword
            inline const word& keyword() const;

            //- Return const access to the mesh database
            inline const fvMesh& mesh() const;

            //- Return the coefficients sub-dictionary
            inline const dictionary& coeffs(const dictionary&) const;


        // Checks

            //- Return the list of fields for which the fvModel adds source term
            //  to the transport equation
            virtual wordList addSupFields() const;

            //- Return true if the fvModel adds a source term to the given
            //  field's transport equation
            virtual bool addsSupToField(const word& fieldName) const;

            //- Return the maximum time-step for stable operation
            virtual scalar maxDeltaT() const;


        // Sources

            //- Add a source term to a field-less proxy equation
            virtual void addSup(fvMatrix<scalar>& eqn) const;

            //- Add a source term to an equation
            FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_FIELD_SUP)

            //- Add a source term to a compressible equation
            FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP)

            //- Add a source term to a phase equation
            FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP)

            //- Return source for an equation
            template<class Type>
            tmp<fvMatrix<Type>> sourceProxy
            (
                const VolField<Type>& eqnField
            ) const;

            //- Return source for an equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const VolField<Type>& field
            ) const;

            //- Return source for an equation
            template<class Type>
            tmp<fvMatrix<Type>> sourceProxy
            (
                const VolField<Type>& field,
                const VolField<Type>& eqnField
            ) const;

            //- Return source for a compressible equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const volScalarField& rho,
                const VolField<Type>& field
            ) const;

            //- Return source for a compressible equation
            template<class Type>
            tmp<fvMatrix<Type>> sourceProxy
            (
                const volScalarField& rho,
                const VolField<Type>& field,
                const VolField<Type>& eqnField
            ) const;

            //- Return source for a phase equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const volScalarField& alpha,
                const volScalarField& rho,
                const VolField<Type>& field
            ) const;

            //- Return source for a phase equation
            template<class Type>
            tmp<fvMatrix<Type>> sourceProxy
            (
                const volScalarField& alpha,
                const volScalarField& rho,
                const VolField<Type>& field,
                const VolField<Type>& eqnField
            ) const;

            //- Return source for a phase equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const volScalarField& alpha,
                const geometricOneField& rho,
                const VolField<Type>& field
            ) const;

            //- Return source for a phase equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const geometricOneField& alpha,
                const volScalarField& rho,
                const VolField<Type>& field
            ) const;

            //- Return source for a phase equation
            template<class Type>
            tmp<fvMatrix<Type>> source
            (
                const geometricOneField& alpha,
                const geometricOneField& rho,
                const VolField<Type>& field
            ) const;

            //- Return source for an equation with a second time derivative
            template<class Type>
            tmp<fvMatrix<Type>> d2dt2
            (
                const VolField<Type>& field
            ) const;


        // Mesh changes

            //- Prepare for mesh update
            virtual void preUpdateMesh();

            //- Update for mesh motion
            virtual bool movePoints() = 0;

            //- Update topology using the given map
            virtual void topoChange(const polyTopoChangeMap&) = 0;

            //- Update from another mesh using the given map
            virtual void mapMesh(const polyMeshMap&) = 0;

            //- Redistribute or update using the given distribution map
            virtual void distribute(const polyDistributionMap&) = 0;


        //- Correct the fvModel
        //  e.g. solve equations, update model, for film, Lagrangian etc.
        virtual void correct();


        // IO

            //- Read source dictionary
            virtual bool read(const dictionary& dict);

            //- Write fvModel data
            virtual bool write(const bool write = true) const;
};


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

} // End namespace Foam

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

#include "fvModelI.H"

#ifdef NoRepository
    #include "fvModelTemplates.C"
#endif

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

#endif

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