DynamicID Class Reference

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

Inheritance diagram for DynamicID:

Collaboration diagram for DynamicID:

Public Member Functions
	DynamicID (const keyType &key, const ObjectType &obj)
	Construct from name. More...
	DynamicID (Istream &is, const ObjectType &obj)
	Construct from Istream. More...
const keyType &	name () const
	Return name. More...
const labelList &	indices () const
	Return indices of matching zones. More...
label	index () const
	Return index of first matching zone. More...
bool	active () const
	Has the zone been found. More...
void	update (const ObjectType &obj)
	Update. More...

Private Attributes
keyType	key_
	Zone name. More...
labelList	indices_
	Zone indices. More...

Friends
Ostream &	operator (Ostream &, const DynamicID< ObjectType > &)

Detailed Description

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 47 of file DynamicID.H.

Constructor & Destructor Documentation

DynamicID() [1/2]

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

inline

Construct from name.

Definition at line 73 of file DynamicID.H.

DynamicID() [2/2]

DynamicID ( Istream &  is, const ObjectType &  obj  )

inline

Construct from Istream.

Definition at line 80 of file DynamicID.H.

Member Function Documentation

name()

const keyType& name ( ) const

inline

Return name.

Definition at line 95 of file DynamicID.H.

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

Here is the caller graph for this function:

indices()

const labelList& indices ( ) const

inline

Return indices of matching zones.

Definition at line 101 of file DynamicID.H.

index()

label index ( ) const

inline

Return index of first matching zone.

Definition at line 107 of file DynamicID.H.

Referenced by slidingInterface::calcAttachedAddressing(), layerAdditionRemoval::checkDefinition(), attachDetach::checkDefinition(), slidingInterface::checkDefinition(), slidingInterface::coupleInterface(), sampledCuttingPlane::createGeometry(), layerAdditionRemoval::extrusionDir(), Foam::operator<<(), slidingInterface::projectPoints(), layerAdditionRemoval::setLayerPairing(), and layerAdditionRemoval::validCollapse().

Here is the caller graph for this function:

active()

bool active ( ) const

inline

Has the zone been found.

Definition at line 113 of file DynamicID.H.

Referenced by layerAdditionRemoval::checkDefinition(), attachDetach::checkDefinition(), and slidingInterface::checkDefinition().

Here is the caller graph for this function:

update()

void update ( const ObjectType &  obj )

inline

Update.

Definition at line 122 of file DynamicID.H.

Friends And Related Function Documentation

operator

Ostream& operator ( Ostream &  , const DynamicID< ObjectType > &    )

friend

Field Documentation

key_

keyType key_

private

Zone name.

Definition at line 62 of file DynamicID.H.

Referenced by DynamicID< pointZoneMesh >::name(), and DynamicID< pointZoneMesh >::update().

indices_

labelList indices_

private

Zone indices.

Definition at line 65 of file DynamicID.H.

Referenced by DynamicID< pointZoneMesh >::active(), DynamicID< pointZoneMesh >::index(), DynamicID< pointZoneMesh >::indices(), and DynamicID< pointZoneMesh >::update().

---

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

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