fvMeshTopoChanger.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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::fvMeshTopoChanger
 
Description
    Abstract base class for fvMesh topology changers.
 
    These classes apply topology changes to the mesh,
    e.g. refinement/unrefinement, layer addition/removal, mesh-to-mesh mapping
    etc.
 
SourceFiles
    fvMeshTopoChanger.C
    fvMeshTopoChangerNew.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef fvMeshTopoChanger_H
#define fvMeshTopoChanger_H
 
#include "fvMesh.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class fvMeshTopoChanger Declaration
\*---------------------------------------------------------------------------*/
 
class fvMeshTopoChanger
{
    // Private Data
 
        //- Non-const fvMesh reference to allow update
        fvMesh& mesh_;
 
 
public:
 
    //- Runtime type information
    TypeName("fvMeshTopoChanger");
 
 
    // Declare run-time constructor selection table
 
        declareRunTimeSelectionTable
        (
            autoPtr,
            fvMeshTopoChanger,
            fvMesh,
            (fvMesh& mesh, const dictionary& dict),
            (mesh, dict)
        );
 
 
    // Constructors
 
        //- Construct from fvMesh
        explicit fvMeshTopoChanger(fvMesh&);
 
        //- Disallow default bitwise copy construction
        fvMeshTopoChanger(const fvMeshTopoChanger&) = delete;
 
 
    // Selectors
 
        //- Select, construct and return the fvMeshTopoChanger
        static autoPtr<fvMeshTopoChanger> New(fvMesh&, const dictionary& dict);
 
        //- Select, construct and return the fvMeshTopoChanger
        static autoPtr<fvMeshTopoChanger> New(fvMesh&);
 
 
    //- Destructor
    virtual ~fvMeshTopoChanger();
 
 
    // Member Functions
 
        //- Return the fvMesh
        fvMesh& mesh()
        {
            return mesh_;
        }
 
        //- Return the fvMesh
        const fvMesh& mesh() const
        {
            return mesh_;
        }
 
        //- Is mesh dynamic, i.e. might it change?
        //  Defaults to true, set to false in the fvMeshTopoChangers::none
        virtual bool dynamic() const
        {
            return true;
        }
 
        //- Update the mesh for both mesh motion and topology change
        virtual bool update() = 0;
 
        //- Update corresponding to the given map
        virtual void topoChange(const polyTopoChangeMap&) = 0;
 
        //- Update from another mesh using the given map
        virtual void mapMesh(const polyMeshMap&) = 0;
 
        //- Update corresponding to the given distribution map
        virtual void distribute(const polyDistributionMap&) = 0;
 
        //- Write the mover state
        virtual bool write(const bool write = true) const
        {
            return true;
        }
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const fvMeshTopoChanger&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //