Public Member Functions | List of all members
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 >:
Inheritance graph
[legend]

Public Member Functions

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

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

Construct from selector name and object.

Definition at line 70 of file DynamicID.H.

◆ DynamicID() [2/5]

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

Construct from selector name and object.

Definition at line 79 of file DynamicID.H.

◆ DynamicID() [3/5]

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]

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]

DynamicID ( Istream &  is,
const ObjectType &  obj 
)
inline

Construct from Istream and object.

Definition at line 104 of file DynamicID.H.

◆ ~DynamicID()

~DynamicID ( )
default

Destructor.

Member Function Documentation

◆ name()

const wordRe& name ( ) const
inlinenoexcept

The selector name.

Definition at line 123 of file DynamicID.H.

Referenced by enginePiston::writeDict().

Here is the caller graph for this function:

◆ indices()

const labelList& indices ( ) const
inlinenoexcept

The indices of matching items.

Definition at line 131 of file DynamicID.H.

◆ index()

label index ( ) const
inline

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

Definition at line 139 of file DynamicID.H.

◆ active()

bool active ( ) const
inlinenoexcept

Has the zone been found.

Definition at line 147 of file DynamicID.H.

◆ update()

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: