/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2022-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::solver

Description
    Abstract base class for run-time selectable region solvers.

SourceFiles
    solver.C
    solverNew.C

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

#ifndef solver_H
#define solver_H

#include "fvMesh.H"
#include "pimpleNoLoopControl.H"
#include "fvModels.H"
#include "fvConstraints.H"
#include "regionName.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                        Class solver Declaration
\*---------------------------------------------------------------------------*/

class solver
:
    public regIOobject
{
protected:

    // Protected Data

        //- Region mesh
        fvMesh& mesh_;

        //- Switch for steady-state
        //  Set automatically from the selected ddt scheme
        bool steady;

        //- Switch for local time step transient operation
        //  Set automatically from the selected ddt scheme
        bool LTS;


private:

    // Private Data

        //- Pointer to the demand driven fvModels MeshObject
        mutable Foam::fvModels* fvModelsPtr;

        //- Pointer to the demand driven fvConstraints MeshObject
        mutable Foam::fvConstraints* fvConstraintsPtr;


    // Private Member Functions

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


protected:

        //- Read controls
        virtual bool read();


public:

    // Public Data

        //- Region mesh
        const fvMesh& mesh;

        //- Time
        const Time& runTime;

        //- PIMPLE inner-loop controls
        pimpleNoLoopControl pimple;

        //- deltaT increase factor
        static scalar deltaTFactor;


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


    // Declare run-time constructor selection table

        declareRunTimeSelectionTable
        (
            autoPtr,
            solver,
            fvMesh,
            (fvMesh& mesh),
            (mesh)
        );


    // Constructors

        //- Construct from region mesh
        solver(fvMesh& mesh);

        //- Disallow default bitwise copy construction
        solver(const solver&) = delete;


    // Selectors

        //- Select, construct and return the solver
        static autoPtr<solver> New
        (
            const word& solverName,
            fvMesh& mesh
        );

        //- Load the specified solver library
        static void load(const word& solverName);


    //- Destructor
    virtual ~solver();


    // Member Functions

        bool transient() const
        {
            return !steady && !LTS;
        }

        //- Return the fvModels that are created on demand
        Foam::fvModels& fvModels() const;

        //- Return the fvConstraints that are created on demand
        Foam::fvConstraints& fvConstraints() const;

        //- Return the current maximum time-step for stable solution
        virtual scalar maxDeltaT() const = 0;

        //- Called at the start of the time-step, before the PIMPLE loop
        virtual void preSolve() = 0;

        //- Called at the start of the PIMPLE loop to move the mesh
        virtual void moveMesh() = 0;

        //- Corrections that follow mesh motion
        virtual void motionCorrector() = 0;

        //- Called at the start of the PIMPLE loop
        virtual void prePredictor() = 0;

        //- Predict the momentum transport
        virtual void momentumTransportPredictor() = 0;

        //- Predict thermophysical transport
        virtual void thermophysicalTransportPredictor() = 0;

        //- Construct and optionally solve the momentum equation
        virtual void momentumPredictor() = 0;

        //- Construct and solve the thermophysical property equations,
        //  convert to temperature
        //  and update thermophysical and transport properties
        virtual void thermophysicalPredictor() = 0;

        //- Construct and solve the pressure equation in the PISO loop
        virtual void pressureCorrector() = 0;

        //- Correct the momentum transport
        virtual void momentumTransportCorrector() = 0;

        //- Correct the thermophysical transport
        virtual void thermophysicalTransportCorrector() = 0;

        //- Called after the PIMPLE loop at the end of the time-step
        virtual void postSolve() = 0;


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const solver&) = delete;
};


template<>
inline const word& regionName(const solver& region)
{
    return regionName(region.mesh);
}


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

} // End namespace Foam

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

#endif

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