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

#include <MeshObject.H>

Inheritance diagram for MeshObject< Mesh, MeshObjectType, Type >:

[legend]

Collaboration diagram for MeshObject< Mesh, MeshObjectType, Type >:

[legend]

Public Member Functions
	MeshObject (const Mesh &mesh)
	Construct with Type::typeName on Mesh.
	MeshObject (const word &objName, const Mesh &mesh)
	Construct with given object name on Mesh.
virtual	~MeshObject ()=default
	Destructor.
const Mesh &	mesh () const noexcept
	Reference to the mesh.
virtual bool	writeData (Ostream &os) const
	Dummy write.

Static Public Member Functions
template<class... Args>
static FOAM_NO_DANGLING_REFERENCE const Type &	New (const Mesh &mesh, Args &&... args)
	Get existing or create MeshObject registered with typeName.
template<class... Args>
static FOAM_NO_DANGLING_REFERENCE const Type &	New (const word &objName, const Mesh &mesh, Args &&... args)
	Get existing or create MeshObject with given registration name.
static bool	Store (std::unique_ptr< Type > &&ptr)
	Transfer ownership of meshObject to registry.
static bool	Delete (const word &objName, const Mesh &mesh)
	Static destructor using given registration name.
static bool	Delete (const Mesh &mesh)
	Static destructor using Type::typeName.
static std::unique_ptr< Type >	Release (const word &objName, const Mesh &mesh, bool checkout=true)
	Release ownership of meshObject (with given registration name) from registry. Returns nullptr if not found or not owned.
static std::unique_ptr< Type >	Release (const Mesh &mesh, bool checkout=true)
	Release ownership of meshObject (with Type::typeName name) from registry.

Protected Attributes
const Mesh &	mesh_
	Reference to the mesh.

Detailed Description

template<class Mesh, template< class > class MeshObjectType, class Type>
class Foam::MeshObject< Mesh, MeshObjectType, Type >

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, UpdateableMeshObject) and the type of the actual object it is created for.

Example usage,

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

The 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 movePoints or updateMesh

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

SourceFiles meshObject.C MeshObject.C

\*—————————————————————————

Definition at line 152 of file MeshObject.H.

Constructor & Destructor Documentation

◆ MeshObject() [1/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

MeshObject ( const Mesh & mesh )

explicit

Construct with Type::typeName on Mesh.

◆ MeshObject() [2/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

MeshObject	(	const word &	objName,
		const Mesh &	mesh )

Construct with given object name on Mesh.

◆ ~MeshObject()

template<class Mesh, template< class > class MeshObjectType, class Type>

virtual ~MeshObject ( )

virtualdefault

Destructor.

Member Function Documentation

◆ New() [1/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

template<class... Args>

FOAM_NO_DANGLING_REFERENCE const Type & New	(	const Mesh &	mesh,
		Args &&...	args )

static

Get existing or create MeshObject registered with typeName.

Referenced by geometricElementTransformPointSmoother::calculate(), and geometricElementTransformPointSmoother::cellQuality().

Here is the caller graph for this function:

◆ New() [2/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

template<class... Args>

FOAM_NO_DANGLING_REFERENCE const Type & New	(	const word &	objName,
		const Mesh &	mesh,
		Args &&...	args )

static

Get existing or create MeshObject with given registration name.

◆ Store()

template<class Mesh, template< class > class MeshObjectType, class Type>

bool Store ( std::unique_ptr< Type > && ptr )

static

Transfer ownership of meshObject to registry.

◆ Delete() [1/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

bool Delete	(	const word &	objName,
		const Mesh &	mesh )

static

Static destructor using given registration name.

Referenced by MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >::Delete().

Here is the caller graph for this function:

◆ Delete() [2/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

bool Delete ( const Mesh & mesh )

inlinestatic

Static destructor using Type::typeName.

Definition at line 219 of file MeshObject.H.

◆ Release() [1/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

std::unique_ptr< Type > Release	(	const word &	objName,
		const Mesh &	mesh,
		bool	checkout = true )

static

Release ownership of meshObject (with given registration name) from registry. Returns nullptr if not found or not owned.

Parameters

checkout Perform checkOut() from the registry

Referenced by MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >::Release().

Here is the caller graph for this function:

◆ Release() [2/2]

template<class Mesh, template< class > class MeshObjectType, class Type>

std::unique_ptr< Type > Release	(	const Mesh &	mesh,
		bool	checkout = true )

inlinestatic

Release ownership of meshObject (with Type::typeName name) from registry.

Parameters

checkout Perform checkOut() from the registry

Definition at line 241 of file MeshObject.H.

◆ mesh()

template<class Mesh, template< class > class MeshObjectType, class Type>

const Mesh & mesh ( ) const

inlinenoexcept

Reference to the mesh.

Definition at line 257 of file MeshObject.H.

Referenced by LeastSquaresVectors< Foam::centredCPCCellToCellStencilObject >::LeastSquaresVectors(), masterCoarsestGAMGProcAgglomeration::masterCoarsestGAMGProcAgglomeration(), and lumpedPointDisplacementPointPatchVectorField::setPatchControls().

Here is the caller graph for this function:

◆ writeData()

template<class Mesh, template< class > class MeshObjectType, class Type>

virtual bool writeData ( Ostream & os ) const

inlinevirtual

Dummy write.

Definition at line 265 of file MeshObject.H.

Member Data Documentation

◆ mesh_

template<class Mesh, template< class > class MeshObjectType, class Type>

const Mesh& mesh_

protected

Reference to the mesh.

Definition at line 161 of file MeshObject.H.

Referenced by LeastSquaresVectors< Foam::centredCPCCellToCellStencilObject >::stencil().

The documentation for this class was generated from the following file:

src/OpenFOAM/meshes/MeshObject/MeshObject.H

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MeshObject() [1/2]

◆ MeshObject() [2/2]

◆ ~MeshObject()

Member Function Documentation

◆ New() [1/2]

◆ New() [2/2]

◆ Store()

◆ Delete() [1/2]

◆ Delete() [2/2]

◆ Release() [1/2]

◆ Release() [2/2]

◆ mesh()

◆ writeData()

Member Data Documentation

◆ mesh_