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

Description
    Mesh representing a set of points created from polyMesh.

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

#ifndef pointMesh_H
#define pointMesh_H

#include "DemandDrivenMeshObject.H"
#include "polyMesh.H"
#include "pointBoundaryMesh.H"
#include "pointFieldsFwd.H"
#include "SlicedDimensionedField.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                          Class pointMesh Declaration
\*---------------------------------------------------------------------------*/

class pointMesh
:
    public DemandDrivenMeshObject<polyMesh, PermanentMeshObject, pointMesh>
{
    // Private Data

        //- Reference to polyMesh
        const polyMesh& mesh_;

        //- Boundary mesh
        pointBoundaryMesh boundary_;

        //- Dimensioned points
        mutable autoPtr<SlicedDimensionedField<point, pointMesh>> pointsPtr_;


protected:

    //- Declare friendship with the base mesh object so that it can use
    //  this class' protected constructors
    friend class DemandDrivenMeshObject
    <
        polyMesh,
        PermanentMeshObject,
        pointMesh
    >;


    // Protected Constructors

        //- Construct from polyMesh
        explicit pointMesh(const polyMesh& pMesh);


public:

    // Public Typedefs

        //- Mesh type
        typedef pointMesh Mesh;

        //- Boundary mesh type
        typedef pointBoundaryMesh BoundaryMesh;

        //- Zone type
        typedef pointZone Zone;

        //- Patch field type
        template<class Type>
        using PatchField = pointPatchField<Type>;

        //- Field source type
        template<class Type>
        using FieldSource = NoFieldSource<Type>;


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


    // Static data

        //- Set of names of registered geometric fields
        const static HashSet<word> geometryFields;

        //- Set of names of registered current-time geometric fields
        const static HashSet<word> curGeometryFields;


    // Constructors

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


    //- Destructor
    ~pointMesh();


    // Member Functions

        //- Return reference to polyMesh
        const polyMesh& poly() const
        {
            return mesh_;
        }

        //- Return number of points
        label size() const
        {
            return mesh_.nPoints();
        }

        //- Return point locations
        const DimensionedField<vector, pointMesh>& C() const;

        //- Return reference to boundary mesh
        const pointBoundaryMesh& boundary() const
        {
            return boundary_;
        }

        //- Return parallel info
        const globalMeshData& globalData() const
        {
            return mesh_.globalData();
        }

        //- Return database. For now is its polyMesh.
        const objectRegistry& db() const
        {
            return mesh_.db();
        }

        //- Reset pointMesh with respect to the updated polyMesh
        //  For run-time mesh replacement and mesh to mesh mapping
        void reset();

        //- Lookup a dimensioned field for this geometry
        template<class Type>
        tmp<DimensionedField<Type, pointMesh>> lookupField(const word&) const;


        // Mesh callbacks

            //- Move points
            virtual bool movePoints();

            //- Update the mesh corresponding to given map
            virtual void topoChange(const polyTopoChangeMap&);

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

            //- Swap mesh
            //  For run-time mesh replacement and mesh to mesh mapping
            virtual void swap(polyMesh&);

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

            //- 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
            );

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

            //- Clear all but permanent registered meshObjects
            virtual void clear();


    // Member Operators

        //- Return reference to polyMesh
        const polyMesh& operator()() const
        {
            return mesh_;
        }

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

        //- Equality comparison
        bool operator==(const pointMesh& pm) const
        {
            return &pm == this;
        }

        //- Inequality comparison
        bool operator!=(const pointMesh& pm) const
        {
            return &pm != this;
        }
};


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

} // End namespace Foam

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

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

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

#endif

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