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

Description
    Templated abstract base-class for optional mesh objects used to automate
    their allocation to the mesh database and the mesh-modifier event-loop.

    MeshObject is templated on the type of mesh it is allocated to, the type of
    the mesh object (TopologicalMeshObject, GeometricMeshObject,
    MoveableMeshObject, DistributeableMeshObject, UpdateableMeshObject) and the
    type of the actual object it is created for example:

    \verbatim
    class leastSquaresVectors
    :
        public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors>
    {
    .
    .
    .
        //- Delete the least square vectors when the mesh moves
        virtual bool movePoints();
    };
    \endverbatim

    MeshObject types:

    - TopologicalMeshObject: mesh object to be deleted on topology change
    - GeometricMeshObject: mesh object to be deleted on geometry change
    - MoveableMeshObject: mesh object to be updated in movePoints
    - UpdateableMeshObject: mesh object to be updated in topoChange or
        movePoints
    - PatchMeshObject: mesh object to be additionally updated patch changes

Note
    movePoints must be provided for MeshObjects of type MoveableMeshObject
    and both movePoints and topoChange functions must exist, provided for
    MeshObjects of type UpdateableMeshObject.

SourceFiles
    MeshObject.C

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

#ifndef MeshObject_H
#define MeshObject_H

#include "objectRegistry.H"

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

namespace Foam
{

// Forward declarations
class polyTopoChangeMap;
class polyMeshMap;
class polyDistributionMap;

/*---------------------------------------------------------------------------*\
                         Class MeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh, template<class> class MeshObjectType, class Type>
class MeshObject
:
    public MeshObjectType<Mesh>
{

protected:

        // Reference to Mesh
        const Mesh& mesh_;


public:

    // Constructors

        explicit MeshObject(const Mesh& mesh);

        MeshObject(const Mesh& mesh, const IOobject& io);

        static Type& New(Mesh& mesh);

        static const Type& New(const Mesh& mesh);

        template<class... Args>
        static Type& New
        (
            Mesh& mesh,
            const Args&... args
        );

        template<class... Args>
        static const Type& New
        (
            const Mesh& mesh,
            const Args&... args
        );


    // Destructors

        virtual ~MeshObject();

        static bool Delete(const Mesh& mesh);


    // Member Functions

        //- Return true if this MeshObject is found in the mesh registry
        static bool found(const Mesh& mesh);

        const Mesh& mesh() const
        {
            return mesh_;
        }

        virtual bool writeData(Foam::Ostream&) const
        {
            return true;
        }
};


/*---------------------------------------------------------------------------*\
                         Class meshObject Declaration
\*---------------------------------------------------------------------------*/

class meshObject
:
    public regIOobject
{
public:

    // Declare name of the class and its debug switch
    ClassName("meshObject");


    // Constructors

        meshObject(const word& typeName, const objectRegistry& obr);

        meshObject(const word& typeName, const IOobject& io);


    // Static member functions

        template<class Mesh>
        static void movePoints(objectRegistry&);

        template<class Mesh>
        static void topoChange(objectRegistry&, const polyTopoChangeMap&);

        template<class Mesh>
        static void mapMesh(objectRegistry&, const polyMeshMap&);

        template<class Mesh>
        static void distribute(objectRegistry&, const polyDistributionMap&);

        template<class Mesh>
        static void addPatch(objectRegistry&, const label patchi);

        template<class Mesh>
        static void reorderPatches
        (
            objectRegistry&,
            const labelUList& newToOld,
            const bool validBoundary
        );

        template<class Mesh, template<class> class MeshObjectType>
        static void clear(objectRegistry&);

        //- Clear all meshObject derived from FromType up to (but not including)
        //  ToType. Used to clear e.g. all non-updateable meshObjects
        template
        <
            class Mesh,
            template<class> class FromType,
            template<class> class ToType
        >
        static void clearUpto(objectRegistry&);
};


/*---------------------------------------------------------------------------*\
                    Class TopologicalMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class TopologicalMeshObject
:
    public meshObject
{
public:

    TopologicalMeshObject(const word& typeName, const objectRegistry& obr)
    :
        meshObject(typeName, obr)
    {}

    TopologicalMeshObject(const word& typeName, const IOobject& io)
    :
        meshObject(typeName, io)
    {}
};


/*---------------------------------------------------------------------------*\
                     Class GeometricMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class GeometricMeshObject
:
    public TopologicalMeshObject<Mesh>
{
public:

    GeometricMeshObject(const word& typeName, const objectRegistry& obr)
    :
        TopologicalMeshObject<Mesh>(typeName, obr)
    {}

    GeometricMeshObject(const word& typeName, const IOobject& io)
    :
        TopologicalMeshObject<Mesh>(typeName, io)
    {}
};


/*---------------------------------------------------------------------------*\
                     Class MoveableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class MoveableMeshObject
:
    public GeometricMeshObject<Mesh>
{
public:

    MoveableMeshObject(const word& typeName, const objectRegistry& obr)
    :
        GeometricMeshObject<Mesh>(typeName, obr)
    {}

    MoveableMeshObject(const word& typeName, const IOobject& io)
    :
        GeometricMeshObject<Mesh>(typeName, io)
    {}

    virtual bool movePoints() = 0;
};


/*---------------------------------------------------------------------------*\
                   Class DistributeableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class DistributeableMeshObject
:
    public MoveableMeshObject<Mesh>
{
public:

    DistributeableMeshObject(const word& typeName, const objectRegistry& obr)
    :
        MoveableMeshObject<Mesh>(typeName, obr)
    {}

    DistributeableMeshObject(const word& typeName, const IOobject& io)
    :
        MoveableMeshObject<Mesh>(typeName, io)
    {}

    virtual void distribute(const polyDistributionMap& map) = 0;
};


/*---------------------------------------------------------------------------*\
                    Class UpdateableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class UpdateableMeshObject
:
    public DistributeableMeshObject<Mesh>
{
public:

    UpdateableMeshObject(const word& typeName, const objectRegistry& obr)
    :
        DistributeableMeshObject<Mesh>(typeName, obr)
    {}

    UpdateableMeshObject(const word& typeName, const IOobject& io)
    :
        DistributeableMeshObject<Mesh>(typeName, io)
    {}

    virtual void topoChange(const polyTopoChangeMap& map) = 0;

    virtual void mapMesh(const polyMeshMap& map) = 0;
};


/*---------------------------------------------------------------------------*\
                       Class PatchMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class PatchMeshObject
:
    public UpdateableMeshObject<Mesh>
{
public:

    PatchMeshObject(const word& typeName, const objectRegistry& obr)
    :
        UpdateableMeshObject<Mesh>(typeName, obr)
    {}

    PatchMeshObject(const word& typeName, const IOobject& io)
    :
        UpdateableMeshObject<Mesh>(typeName, io)
    {}

    //- Reordered/removed trailing patches. If validBoundary call is parallel
    //  synced and all add the same patch with same settings
    virtual void reorderPatches
    (
        const labelUList& newToOld,
        const bool validBoundary
    ) = 0;

    //- Inserted patch at patchi
    virtual void addPatch(const label patchi) = 0;
};


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

} // End namespace Foam

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

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

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

#endif

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