MeshObject< Mesh, MeshObjectType, Type > Class Template Reference

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

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

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

Public Member Functions
	MeshObject (const Mesh &mesh)
virtual	~MeshObject ()
const Mesh &	mesh () const
virtual bool	writeData (Foam::Ostream &) const

Static Public Member Functions
static const Type &	New (const Mesh &mesh)
template<class Data1 >
static const Type &	New (const Mesh &mesh, const Data1 &d)
template<class Data1 , class Data2 >
static const Type &	New (const Mesh &mesh, const Data1 &, const Data2 &)
template<class Data1 , class Data2 , class Data3 >
static const Type &	New (const Mesh &mesh, const Data1 &, const Data2 &, const Data3 &)
template<class Data1 , class Data2 , class Data3 , class Data4 >
static const Type &	New (const Mesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
static bool	Delete (const Mesh &mesh)

Protected Attributes
const Mesh &	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:

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

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 updateMesh 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 updateMesh functions must exist, provided for MeshObjects of type UpdateableMeshObject.

Source files

• MeshObject.H
• MeshObject.C

Definition at line 86 of file MeshObject.H.

Constructor & Destructor Documentation

MeshObject()

MeshObject ( const Mesh &  mesh )

explicit

Definition at line 33 of file MeshObject.C.

~MeshObject()

~MeshObject ( )

virtual

Definition at line 279 of file MeshObject.C.

Member Function Documentation

New() [1/5]

const Type & New ( const Mesh &  mesh )

static

Definition at line 44 of file MeshObject.C.

Referenced by MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >::MeshObject(), and MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >::New().

Here is the caller graph for this function:

New() [2/5]

const Type & New ( const Mesh &  mesh, const Data1 &  d  )

static

Definition at line 82 of file MeshObject.C.

New() [3/5]

const Type & New ( const Mesh &  mesh, const Data1 &  d1, const Data2 &  d2  )

static

Definition at line 121 of file MeshObject.C.

New() [4/5]

const Type & New ( const Mesh &  mesh, const Data1 &  d1, const Data2 &  d2, const Data3 &  d3  )

static

Definition at line 163 of file MeshObject.C.

New() [5/5]

const Type & New ( const Mesh &  mesh, const Data1 &  d1, const Data2 &  d2, const Data3 &  d3, const Data4 &  d4  )

static

Definition at line 203 of file MeshObject.C.

Delete()

bool Delete ( const Mesh &  mesh )

static

Definition at line 244 of file MeshObject.C.

mesh()

const Mesh& mesh ( ) const

inline

Definition at line 149 of file MeshObject.H.

writeData()

virtual bool writeData ( Foam::Ostream &  ) const

inlinevirtual

Definition at line 154 of file MeshObject.H.

Member Data Documentation

mesh_

const Mesh& mesh_

protected

Definition at line 94 of file MeshObject.H.

Referenced by MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >::mesh().

---

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

• src/OpenFOAM/meshes/MeshObject/MeshObject.H
• src/OpenFOAM/meshes/MeshObject/MeshObject.C