DynamicID< ObjectType > Class Template Reference

A class that holds the data needed to identify things (zones, patches) in a dynamic mesh. More...

Inheritance diagram for DynamicID< ObjectType >:

Public Member Functions
	DynamicID (const wordRe &key, const ObjectType &obj)
	DynamicID (wordRe &&key, const ObjectType &obj)
	DynamicID (const word &key, const ObjectType &obj)
	DynamicID (const keyType &key, const ObjectType &obj)
	DynamicID (Istream &is, const ObjectType &obj)
	~DynamicID ()=default
const wordRe &	name () const noexcept
const labelList &	indices () const noexcept
label	index () const
bool	active () const noexcept
void	update (const ObjectType &obj)

Detailed Description

template<class ObjectType>
class Foam::DynamicID< ObjectType >

A class that holds the data needed to identify things (zones, patches) in a dynamic mesh.

The thing is identified by name. Its indices are updated if the mesh has changed.

Definition at line 48 of file DynamicID.H.

Constructor & Destructor Documentation

DynamicID() [1/5]

DynamicID ( const wordRe &  key, const ObjectType &  obj  )

inline

Definition at line 64 of file DynamicID.H.

DynamicID() [2/5]

DynamicID ( wordRe &&  key, const ObjectType &  obj  )

inline

Definition at line 71 of file DynamicID.H.

DynamicID() [3/5]

DynamicID ( const word &  key, const ObjectType &  obj  )

inline

Definition at line 78 of file DynamicID.H.

DynamicID() [4/5]

DynamicID ( const keyType &  key, const ObjectType &  obj  )

inline

Definition at line 84 of file DynamicID.H.

DynamicID() [5/5]

DynamicID ( Istream &  is, const ObjectType &  obj  )

inline

Definition at line 90 of file DynamicID.H.

~DynamicID()

~DynamicID ( )

default

Member Function Documentation

name()

const wordRe& name ( ) const

inlinenoexcept

Definition at line 105 of file DynamicID.H.

Referenced by Foam::operator<<(), and enginePiston::writeDict().

Here is the caller graph for this function:

indices()

const labelList& indices ( ) const

inlinenoexcept

Definition at line 111 of file DynamicID.H.

index()

label index ( ) const

inline

Definition at line 117 of file DynamicID.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

active()

bool active ( ) const

inlinenoexcept

Definition at line 123 of file DynamicID.H.

update()

void update ( const ObjectType &  obj )

inline

Definition at line 132 of file DynamicID.H.

---

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

• src/OpenFOAM/meshes/Identifiers/DynamicID/DynamicID.H