DynamicID< ObjectType > Class Template Reference

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

#include <DynamicID.H>

Inheritance diagram for DynamicID< ObjectType >:

Public Member Functions
	DynamicID (const wordRe &key, const ObjectType &obj)
	Construct from selector name and object.
	DynamicID (wordRe &&key, const ObjectType &obj)
	Construct from selector name and object.
	DynamicID (const word &key, const ObjectType &obj)
	Construct from selector name and object.
	DynamicID (const keyType &key, const ObjectType &obj)
	Construct from selector name and object.
	DynamicID (Istream &is, const ObjectType &obj)
	Construct from Istream and object.
	~DynamicID ()=default
	Destructor.
const wordRe &	name () const noexcept
	The selector name.
const labelList &	indices () const noexcept
	The indices of matching items.
label	index () const
	The index of the first matching items, -1 if no matches.
bool	active () const noexcept
	Has the zone been found.
void	update (const ObjectType &obj)
	Update.

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]

template<class ObjectType>

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

inline

Construct from selector name and object.

Definition at line 70 of file DynamicID.H.

DynamicID() [2/5]

template<class ObjectType>

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

inline

Construct from selector name and object.

Definition at line 79 of file DynamicID.H.

DynamicID() [3/5]

template<class ObjectType>

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

inline

Construct from selector name and object.

Definition at line 88 of file DynamicID.H.

DynamicID() [4/5]

template<class ObjectType>

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

inline

Construct from selector name and object.

Definition at line 96 of file DynamicID.H.

DynamicID() [5/5]

template<class ObjectType>

DynamicID ( Istream & is, const ObjectType & obj )

inline

Construct from Istream and object.

Definition at line 104 of file DynamicID.H.

~DynamicID()

template<class ObjectType>

~DynamicID ( )

default

Destructor.

Member Function Documentation

name()

template<class ObjectType>

const wordRe & name ( ) const

inlinenoexcept

The selector name.

Definition at line 123 of file DynamicID.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

indices()

template<class ObjectType>

const labelList & indices ( ) const

inlinenoexcept

The indices of matching items.

Definition at line 131 of file DynamicID.H.

index()

template<class ObjectType>

label index ( ) const

inline

The index of the first matching items, -1 if no matches.

Definition at line 139 of file DynamicID.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

active()

template<class ObjectType>

bool active ( ) const

inlinenoexcept

Has the zone been found.

Definition at line 147 of file DynamicID.H.

update()

template<class ObjectType>

void update ( const ObjectType & obj )

inline

Update.

Definition at line 158 of file DynamicID.H.

---

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

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