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

Inheritance diagram for DemandDrivenMeshObject< Mesh, MeshObjectType, Type, RegIOobject >:

[legend]

Collaboration diagram for DemandDrivenMeshObject< Mesh, MeshObjectType, Type, RegIOobject >:

[legend]

Public Member Functions
virtual const word &	type () const
	Runtime type information. More...

virtual	~DemandDrivenMeshObject ()

const Mesh &	mesh () const

virtual bool	writeData (Foam::Ostream &) const
	Pure virtual writaData function. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const word &newName, const IOobject &, bool registerObject)
	Construct from IOobject with new name, and overriding the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

uint64_t	eventNo () const
	Event number at last update. More...

uint64_t &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption &	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Static Public Member Functions
static Type &	New (const word &name, const Mesh &mesh)
	Construct and return the named DemandDrivenMeshObject. More...

static Type &	New (const Mesh &mesh)
	Construct and return the DemandDrivenMeshObject named Type::typeName. More...

template<class... Args>
static Type &	New (const word &name, const Mesh &mesh, const Args &... args)
	Construct and return the named DemandDrivenMeshObject. More...

template<class... Args>
static Type &	New (const Mesh &mesh, const Args &... args)
	Construct and return the DemandDrivenMeshObject named Type::typeName. More...

static bool	found (const word &name, const Mesh &mesh)
	Return true if the DemandDrivenMeshObject with the given name. More...

static bool	found (const Mesh &mesh)
	Return true if the DemandDrivenMeshObject named Type::typeName. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static bool	writeHeader (Ostream &os, const IOstream::versionNumber version, const IOstream::streamFormat format, const word &type, const string &note, const fileName &location, const word &name)
	Write header. More...

static bool	writeHeader (Ostream &, const dictionary &foamFileDict)
	Write header. More...

Protected Member Functions
	DemandDrivenMeshObject (const IOobject &io, const Mesh &mesh)
	Construct from mesh and IOobject. More...

	DemandDrivenMeshObject (const word &name, const Mesh &mesh)
	Construct from mesh and name. More...

	DemandDrivenMeshObject (const Mesh &mesh)
	Construct from mesh, the name is set to Type::typeName. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Detailed Description

template<class Mesh, template< class > class MeshObjectType, class Type, class RegIOobject = regIOobject>
class Foam::DemandDrivenMeshObject< Mesh, MeshObjectType, Type, RegIOobject >

Templated abstract base-class for demand-driven mesh objects used to automate their allocation to the mesh database and the m esh-modifier event-loop.

DemandDrivenMeshObject is templated on the type of mesh it is allocated to, the type of the mesh object (DeletableMeshObject, MoveableMeshObject, DistributeableMeshObject, TopoChangeableMeshObject), the type of the object it is created for and optionally the type of registered object which defaults to regIOobject, e.g.:

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

or if the object is read from a special IOdictionary it can be derived from an IOdictionary stored by the DemandDrivenMeshObject, e.g.:

class fvModels
:
    public DemandDrivenMeshObject
    <
        fvMesh,
        TopoChangeableMeshObject,
        fvModels,
        IOdictionary
    >,
    public MRFZoneList
{
.
.
.
};

MeshObject types:

DeletableMeshObject: mesh object to be deleted after any mesh change
MoveableMeshObject: mesh object to be updated after mesh motion otherwise deleted
DistributeableMeshObject mesh object to be updated after mesh redistribution or motion otherwise deleted
TopoChangeableMeshObject: mesh object to be updated after mesh topology change, mesh-to-mesh mapping, redistribution or motion otherwise deleted
RepatchableMeshObject: mesh object to be updated on patch or topology change, mesh-to-mesh mapping, redistribution or motion otherwise deleted

DemandDrivenMeshObject should always be constructed and accessed via the New methods provided so that they are held and maintained by the objectRegistry. To ensure this use constructors of the concrete derived types should be private or protected and friendship with the DemandDrivenMeshObject base-class declared so that the New functions can call the the constructors.

Source files

Definition at line 122 of file DemandDrivenMeshObject.H.

Constructor & Destructor Documentation

◆ DemandDrivenMeshObject() [1/3]

DemandDrivenMeshObject	(	const IOobject &	io,
		const Mesh &	mesh
	)

protected

Construct from mesh and IOobject.

Only derived classes can construct DemandDrivenMeshObject

Definition at line 38 of file DemandDrivenMeshObject.C.

◆ DemandDrivenMeshObject() [2/3]

DemandDrivenMeshObject	(	const word &	name,
		const Mesh &	mesh
	)

protected

Construct from mesh and name.

Only derived classes can construct DemandDrivenMeshObject

Definition at line 58 of file DemandDrivenMeshObject.C.

◆ DemandDrivenMeshObject() [3/3]

DemandDrivenMeshObject ( const Mesh & mesh )

protected

Construct from mesh, the name is set to Type::typeName.

Only derived classes can construct DemandDrivenMeshObject

Definition at line 86 of file DemandDrivenMeshObject.C.

◆ ~DemandDrivenMeshObject()

~DemandDrivenMeshObject

virtual

Definition at line 259 of file DemandDrivenMeshObject.C.

References regIOobject::release().

Here is the call graph for this function:

Member Function Documentation

◆ type()

const Foam::word & type

virtual

Runtime type information.

Definition at line 276 of file DemandDrivenMeshObject.C.

References Foam::typeName().

Referenced by GAMGProcAgglomeration::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [1/4]

Type & New	(	const word &	name,
		const Mesh &	mesh
	)

static

Construct and return the named DemandDrivenMeshObject.

Definition at line 109 of file DemandDrivenMeshObject.C.

References fvMesh::db(), Foam::endl(), found, mesh, fvMesh::name(), Foam::name(), Foam::Pout, regIOobject::store(), and Foam::typeName().

Referenced by CentredFitSnGradScheme< Type, Polynomial, Stencil >::correction(), CentredFitScheme< Type, Polynomial, Stencil >::correction(), PureUpwindFitScheme< Type, Polynomial, Stencil >::correction(), and UpwindFitScheme< Type, Polynomial, Stencil >::correction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/4]

Type & New ( const Mesh & mesh )

static

Construct and return the DemandDrivenMeshObject named Type::typeName.

Definition at line 146 of file DemandDrivenMeshObject.C.

◆ New() [3/4]

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

static

Construct and return the named DemandDrivenMeshObject.

with the additional arguments

Definition at line 182 of file DemandDrivenMeshObject.C.

◆ New() [4/4]

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

static

Construct and return the DemandDrivenMeshObject named Type::typeName.

with the additional arguments

Definition at line 221 of file DemandDrivenMeshObject.C.

References args, fvMesh::db(), Foam::endl(), found, mesh, fvMesh::name(), Foam::Pout, regIOobject::store(), and Foam::typeName().

Here is the call graph for this function:

◆ found() [1/2]

bool found	(	const word &	name,
		const Mesh &	mesh
	)

static

Return true if the DemandDrivenMeshObject with the given name.

is found in the mesh registry

Definition at line 290 of file DemandDrivenMeshObject.C.

References fvMesh::db(), mesh, and Foam::name().

Here is the call graph for this function:

◆ found() [2/2]

bool found ( const Mesh & mesh )

static

Return true if the DemandDrivenMeshObject named Type::typeName.

is found in the mesh registry

Definition at line 308 of file DemandDrivenMeshObject.C.

References found, mesh, and Foam::typeName().

Here is the call graph for this function:

◆ mesh()

const Mesh& mesh ( ) const

inline

Definition at line 199 of file DemandDrivenMeshObject.H.

Referenced by Foam::tracking::locate(), pointPatch::mesh(), and molecule::molecule().

Here is the caller graph for this function:

◆ writeData()

virtual bool writeData ( Foam::Ostream & ) const

inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Reimplemented in coordinateSystems.

Definition at line 204 of file DemandDrivenMeshObject.H.

◆ writeObject()

virtual bool writeObject	(	IOstream::streamFormat	,
		IOstream::versionNumber	,
		IOstream::compressionType	,
		const bool	write
	)		const

inlinevirtual

Write using given format, version and compression.

Reimplemented from regIOobject.

Reimplemented in hexRef8, LagrangianModels, and fvModels.

Definition at line 210 of file DemandDrivenMeshObject.H.

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

src/OpenFOAM/meshes/meshObjects/DemandDrivenMeshObject.H
src/OpenFOAM/meshes/meshObjects/DemandDrivenMeshObject.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class Mesh, template< class > class MeshObjectType, class Type, class RegIOobject = regIOobject> class Foam::DemandDrivenMeshObject< Mesh, MeshObjectType, Type, RegIOobject >

Constructor & Destructor Documentation

◆ DemandDrivenMeshObject() [1/3]

◆ DemandDrivenMeshObject() [2/3]

◆ DemandDrivenMeshObject() [3/3]

◆ ~DemandDrivenMeshObject()

Member Function Documentation

◆ type()

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ found() [1/2]

◆ found() [2/2]

◆ mesh()

◆ writeData()

◆ writeObject()

template<class Mesh, template< class > class MeshObjectType, class Type, class RegIOobject = regIOobject>
class Foam::DemandDrivenMeshObject< Mesh, MeshObjectType, Type, RegIOobject >