objectMap Class Reference

An objectMap is a pair of labels defining the mapping of an object from another object, e.g. a cell mapped from a point. More...

Collaboration diagram for objectMap:

Public Member Functions
	objectMap ()
	Null constructor for lists. More...
	objectMap (const label index, const labelList &master)
	Construct from components. More...
	objectMap (Istream &)
	Construct from Istream. More...
label &	index ()
	Return object index. More...
label	index () const
labelList &	masterObjects ()
	Return master object index. More...
const labelList &	masterObjects () const

Private Attributes
label	index_
	Object index. More...
labelList	masterObjects_
	Master object index. More...

Friends
bool	operator== (const objectMap &a, const objectMap &b)
bool	operator!= (const objectMap &a, const objectMap &b)
Ostream &	operator<< (Ostream &, const objectMap &)
Istream &	operator>> (Istream &, objectMap &)

Detailed Description

An objectMap is a pair of labels defining the mapping of an object from another object, e.g. a cell mapped from a point.

Source files

• objectMap.H
• objectMapI.H

Definition at line 58 of file objectMap.H.

Constructor & Destructor Documentation

objectMap() [1/3]

objectMap ( )

inline

Null constructor for lists.

Definition at line 37 of file objectMapI.H.

objectMap() [2/3]

objectMap ( const label  index, const labelList &  master  )

inline

Construct from components.

Definition at line 44 of file objectMapI.H.

objectMap() [3/3]

objectMap ( Istream &  is )

inline

Construct from Istream.

Definition at line 51 of file objectMapI.H.

References IOstream::check(), objectMap::index_, objectMap::masterObjects_, Istream::readBegin(), and Istream::readEnd().

Here is the call graph for this function:

Member Function Documentation

index() [1/2]

label index ( )

inline

Return object index.

Definition at line 68 of file objectMapI.H.

References objectMap::index_.

Referenced by polyTopoChange::getMergeSets().

Here is the caller graph for this function:

index() [2/2]

label index ( ) const

inline

masterObjects() [1/2]

const labelList & masterObjects ( )

inline

Return master object index.

Definition at line 80 of file objectMapI.H.

References objectMap::masterObjects_.

Referenced by polyTopoChange::getMergeSets().

Here is the caller graph for this function:

masterObjects() [2/2]

const labelList& masterObjects ( ) const

inline

Friends And Related Function Documentation

operator==

bool operator== ( const objectMap &  a, const objectMap &  b  )

friend

Definition at line 94 of file objectMapI.H.

operator!=

bool operator!= ( const objectMap &  a, const objectMap &  b  )

friend

Definition at line 103 of file objectMapI.H.

operator<<

Ostream& operator<< ( Ostream &  os, const objectMap &  a  )

friend

Definition at line 111 of file objectMapI.H.

operator>>

Istream& operator>> ( Istream &  is, objectMap &  a  )

friend

Definition at line 125 of file objectMapI.H.

Field Documentation

index_

label index_

private

Object index.

Definition at line 63 of file objectMap.H.

Referenced by objectMap::index(), objectMap::objectMap(), Foam::operator<<(), Foam::operator==(), and Foam::operator>>().

masterObjects_

labelList masterObjects_

private

Master object index.

Definition at line 66 of file objectMap.H.

Referenced by objectMap::masterObjects(), objectMap::objectMap(), Foam::operator<<(), Foam::operator==(), and Foam::operator>>().

---

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

• src/OpenFOAM/meshes/polyMesh/mapPolyMesh/objectMap/objectMap.H
• src/OpenFOAM/meshes/polyMesh/mapPolyMesh/objectMap/objectMapI.H