Mesh representing a set of points created from polyMesh. More...

Inheritance diagram for pointMesh:

Collaboration diagram for pointMesh:

Public Types
typedef pointMesh	Mesh
	Mesh type. More...

typedef pointBoundaryMesh	BoundaryMesh
	Boundary mesh type. More...

typedef pointZone	Zone
	Zone type. More...

template<class Type >
using	PatchField = pointPatchField< Type >
	Patch field type. More...

template<class Type >
using	FieldSource = NoFieldSource< Type >
	Field source type. More...

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...

Public Member Functions
	ClassName ("pointMesh")

	pointMesh (const pointMesh &)=delete
	Disallow default bitwise copy construction. More...

	~pointMesh ()
	Destructor. More...

const polyMesh &	poly () const
	Return reference to polyMesh. More...

label	size () const
	Return number of points. More...

const DimensionedField< vector, pointMesh > &	C () const
	Return point locations. More...

const pointBoundaryMesh &	boundary () const
	Return reference to boundary mesh. More...

const globalMeshData &	globalData () const
	Return parallel info. More...

const objectRegistry &	db () const
	Return database. For now is its polyMesh. More...

void	reset ()
	Reset pointMesh with respect to the updated polyMesh. More...

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

virtual bool	movePoints ()
	Move points. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update the mesh corresponding to given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	swap (polyMesh &)
	Swap mesh. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual void	reorderPatches (const labelUList &newToOld, const bool validBoundary)
	Reordered/removed trailing patches. If validBoundary call is. More...

virtual void	addPatch (const label patchi)
	Inserted patch at patchi. More...

virtual void	clear ()
	Clear all but permanent registered meshObjects. More...

const polyMesh &	operator() () const
	Return reference to polyMesh. More...

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

bool	operator== (const pointMesh &pm) const
	Equality comparison. More...

bool	operator!= (const pointMesh &pm) const
	Inequality comparison. More...

template<class Type >
Foam::tmp< Foam::DimensionedField< Type, Foam::pointMesh > >	lookupField (const word &name) const

Public Member Functions inherited from DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >
virtual const word &	type () const
	Runtime type information. More...

virtual	~DemandDrivenMeshObject ()

const polyMesh &	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)

Public Member Functions inherited from PermanentMeshObject< Mesh >
template<class Type >
	PermanentMeshObject (Type &mo)

Public Member Functions inherited from RepatchableMeshObject< Mesh >
template<class Type >
	RepatchableMeshObject (Type &mo)

Public Member Functions inherited from TopoChangeableMeshObject< Mesh >
template<class Type >
	TopoChangeableMeshObject (Type &mo)

virtual void	swap (Mesh &otherMesh)
	Swap mesh. More...

Public Member Functions inherited from DistributeableMeshObject< Mesh >
template<class Type >
	DistributeableMeshObject (Type &mo)

Public Member Functions inherited from MoveableMeshObject< Mesh >
template<class Type >
	MoveableMeshObject (Type &mo)

Public Member Functions inherited from DeletableMeshObject< Mesh >
template<class Type >
	DeletableMeshObject (Type &mo)

virtual	~DeletableMeshObject ()=default
	Virtual destructor to make class polymorphic. More...

Static Public Attributes
static const HashSet< word >	geometryFields
	Set of names of registered geometric fields. More...

static const HashSet< word >	curGeometryFields
	Set of names of registered current-time geometric fields. 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...

Protected Member Functions
	pointMesh (const polyMesh &pMesh)
	Construct from polyMesh. More...

Protected Member Functions inherited from DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >
	DemandDrivenMeshObject (const IOobject &io, const polyMesh &mesh)
	Construct from mesh and IOobject. More...

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

	DemandDrivenMeshObject (const polyMesh &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...

Friends
class	DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >
	Declare friendship with the base mesh object so that it can use. More...

Additional Inherited Members
Static Public Member Functions inherited from DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >
static pointMesh &	New (const word &name, const polyMesh &mesh)
	Construct and return the named DemandDrivenMeshObject. More...

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

static pointMesh &	New (const word &name, const polyMesh &mesh, const Args &... args)
	Construct and return the named DemandDrivenMeshObject. More...

static pointMesh &	New (const polyMesh &mesh, const Args &... args)
	Construct and return the DemandDrivenMeshObject named Type::typeName. More...

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

static bool	found (const polyMesh &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...

Detailed Description

Mesh representing a set of points created from polyMesh.

Definition at line 49 of file pointMesh.H.

Member Typedef Documentation

◆ Mesh

typedef pointMesh Mesh

Mesh type.

Definition at line 88 of file pointMesh.H.

◆ BoundaryMesh

typedef pointBoundaryMesh BoundaryMesh

Boundary mesh type.

Definition at line 91 of file pointMesh.H.

◆ Zone

typedef pointZone Zone

Zone type.

Definition at line 94 of file pointMesh.H.

◆ PatchField

using PatchField = pointPatchField<Type>

Patch field type.

Definition at line 98 of file pointMesh.H.

◆ FieldSource

using FieldSource = NoFieldSource<Type>

Field source type.

Definition at line 102 of file pointMesh.H.

Constructor & Destructor Documentation

◆ pointMesh() [1/2]

pointMesh ( const polyMesh & pMesh )

explicitprotected

Construct from polyMesh.

Definition at line 47 of file pointMesh.C.

References Foam::endl(), IOobject::name(), and Foam::Pout.

Here is the call graph for this function:

◆ pointMesh() [2/2]

pointMesh ( const pointMesh & )

delete

Disallow default bitwise copy construction.

◆ ~pointMesh()

~pointMesh ( )

Destructor.

Definition at line 67 of file pointMesh.C.

References Foam::endl(), Foam::Pout, and error::printStack().

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "pointMesh" )

◆ poly()

const polyMesh& poly ( ) const

inline

Return reference to polyMesh.

Definition at line 131 of file pointMesh.H.

Referenced by pointPatch::poly().

Here is the caller graph for this function:

◆ size()

label size ( ) const

inline

Return number of points.

Definition at line 137 of file pointMesh.H.

References primitiveMesh::nPoints().

Referenced by pointFieldReconstructor::pointFieldReconstructor(), and pointMapper::pointMapper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ C()

const Foam::DimensionedField< Foam::vector, Foam::pointMesh > & C ( ) const

Return point locations.

Definition at line 81 of file pointMesh.C.

References Foam::dimLength, Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, and Foam::dimensions::time.

Here is the call graph for this function:

◆ boundary()

const pointBoundaryMesh& boundary ( ) const

inline

Return reference to boundary mesh.

Definition at line 146 of file pointMesh.H.

Referenced by motionSmootherAlgo::curPoints(), pointFieldDecomposer::decomposeField(), fvMeshSubset::interpolate(), meshRefinement::makeDisplacementField(), pointFieldDecomposer::pointFieldDecomposer(), and pointFieldReconstructor::pointFieldReconstructor().

Here is the caller graph for this function:

◆ globalData()

const globalMeshData& globalData ( ) const

inline

Return parallel info.

Definition at line 152 of file pointMesh.H.

References polyMesh::globalData().

Referenced by pointConstraints::syncUntransformedData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ db()

const objectRegistry& db ( ) const

inline

Return database. For now is its polyMesh.

Definition at line 158 of file pointMesh.H.

References polyMesh::db().

Referenced by interpolator::curPointField(), pointFieldDecomposer::decomposeField(), fvMeshSubset::interpolate(), volPointInterpolation::interpolate(), and pointMesh::lookupField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void reset ( )

virtual

Reset pointMesh with respect to the updated polyMesh.

For run-time mesh replacement and mesh to mesh mapping

Implements PermanentMeshObject< Mesh >.

Definition at line 280 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ lookupField() [1/2]

tmp<DimensionedField<Type, pointMesh> > lookupField ( const word & ) const

Lookup a dimensioned field for this geometry.

◆ movePoints()

bool movePoints ( )

virtual

Move points.

Implements MoveableMeshObject< Mesh >.

Definition at line 106 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update the mesh corresponding to given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 123 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 138 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ swap()

void swap ( polyMesh & otherMesh )

virtual

Swap mesh.

For run-time mesh replacement and mesh to mesh mapping

Definition at line 153 of file pointMesh.C.

References meshObjects::clearUpto(), Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements DistributeableMeshObject< Mesh >.

Definition at line 185 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ reorderPatches()

void reorderPatches	(	const labelUList &	newToOld,
		const bool	validBoundary
	)

virtual

Reordered/removed trailing patches. If validBoundary call is.

parallel synced and all add the same patch with same settings

Implements RepatchableMeshObject< Mesh >.

Definition at line 200 of file pointMesh.C.

References Foam::endl(), Foam::FOR_ALL_FIELD_TYPES(), Foam::Pout, and ReorderPatchFieldsType.

Here is the call graph for this function:

◆ addPatch()

void addPatch ( const label patchi )

virtual

Inserted patch at patchi.

Implements RepatchableMeshObject< Mesh >.

Definition at line 231 of file pointMesh.C.

References AddPatchFieldsType, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FOR_ALL_FIELD_TYPES(), facePointPatch::New(), patchi, Foam::Pout, and UPtrList< T >::size().

Here is the call graph for this function:

◆ clear()

void clear ( )

virtual

Clear all but permanent registered meshObjects.

Implements PermanentMeshObject< Mesh >.

Definition at line 264 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ operator()()

const polyMesh& operator() ( ) const

inline

Return reference to polyMesh.

Definition at line 208 of file pointMesh.H.

◆ operator=()

void operator= ( const pointMesh & )

delete

Disallow default bitwise assignment.

◆ operator==()

bool operator== ( const pointMesh & pm ) const

inline

Equality comparison.

Definition at line 217 of file pointMesh.H.

◆ operator!=()

bool operator!= ( const pointMesh & pm ) const

inline

Inequality comparison.

Definition at line 223 of file pointMesh.H.

◆ lookupField() [2/2]

Foam::tmp<Foam::DimensionedField<Type, Foam::pointMesh> > lookupField ( const word & name ) const

Definition at line 32 of file pointMeshTemplates.C.

References pointMesh::db(), and IOobject::name().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >

friend class DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >

friend

Declare friendship with the base mesh object so that it can use.

this class' protected constructors

Definition at line 62 of file pointMesh.H.

Member Data Documentation

◆ geometryFields

const Foam::HashSet< Foam::word > geometryFields

static

Set of names of registered geometric fields.

Definition at line 112 of file pointMesh.H.

◆ curGeometryFields

const Foam::HashSet< Foam::word > curGeometryFields

static

Set of names of registered current-time geometric fields.

Definition at line 115 of file pointMesh.H.

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

src/finiteVolume/pointMesh/pointMesh.H
src/finiteVolume/pointMesh/pointMesh.C
src/finiteVolume/pointMesh/pointMeshTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ BoundaryMesh

◆ Zone

◆ PatchField

◆ FieldSource

Constructor & Destructor Documentation

◆ pointMesh() [1/2]

◆ pointMesh() [2/2]

◆ ~pointMesh()

Member Function Documentation

◆ ClassName()

◆ poly()

◆ size()

◆ C()

◆ boundary()

◆ globalData()

◆ db()

◆ reset()

◆ lookupField() [1/2]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ swap()

◆ distribute()

◆ reorderPatches()

◆ addPatch()

◆ clear()

◆ operator()()

◆ operator=()

◆ operator==()

◆ operator!=()

◆ lookupField() [2/2]

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< polyMesh, PermanentMeshObject, pointMesh >

Member Data Documentation

◆ geometryFields

◆ curGeometryFields