Public Member Functions | Friends | List of all members
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...

Public Member Functions

 objectMap ()
 Null constructor, with index=-1 and no objects. More...
 
 objectMap (const label index, const UList< label > &master)
 Construct from components. More...
 
 objectMap (Istream &is)
 Construct from Istream. More...
 
label & index ()
 Return object index. More...
 
label index () const
 
labelList & masterObjects ()
 Return master object index. More...
 
const labelList & masterObjects () const
 

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

Definition at line 60 of file objectMap.H.

Constructor & Destructor Documentation

◆ objectMap() [1/3]

objectMap ( )
inline

Null constructor, with index=-1 and no objects.

Definition at line 32 of file objectMapI.H.

◆ objectMap() [2/3]

objectMap ( const label  index,
const UList< label > &  master 
)
inline

Construct from components.

Definition at line 39 of file objectMapI.H.

◆ objectMap() [3/3]

objectMap ( Istream &  is)
inline

Construct from Istream.

Definition at line 46 of file objectMapI.H.

References IOstream::check(), FUNCTION_NAME, Istream::readBegin(), and Istream::readEnd().

Here is the call graph for this function:

Member Function Documentation

◆ index() [1/2]

Foam::label & index ( )
inline

Return object index.

Definition at line 59 of file objectMapI.H.

◆ index() [2/2]

Foam::label index ( ) const
inline

Definition at line 65 of file objectMapI.H.

◆ masterObjects() [1/2]

Foam::labelList & masterObjects ( )
inline

Return master object index.

Definition at line 71 of file objectMapI.H.

◆ masterObjects() [2/2]

const Foam::labelList & masterObjects ( ) const
inline

Definition at line 77 of file objectMapI.H.

Friends And Related Function Documentation

◆ operator==

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

◆ operator!=

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

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const objectMap &   
)
friend

◆ operator>>

Istream& operator>> ( Istream &  ,
objectMap &   
)
friend
The documentation for this class was generated from the following files: