FreeFOAM The Cross-Platform CFD Toolkit
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...

#include <OpenFOAM/objectMap.H>


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 59 of file objectMap.H.

List of all members.

Public Member Functions

 objectMap ()
 Null constructor for lists.
 objectMap (const label index, const labelList &master)
 Construct from components.
 objectMap (Istream &)
 Construct from Istream.
label & index ()
 Return object index.
label index () const
labelListmasterObjects ()
 Return master object index.
const labelListmasterObjects () const

Friends

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

Constructor & Destructor Documentation

objectMap ( )
inline

Null constructor for lists.

Definition at line 37 of file objectMapI.H.

objectMap ( const label  index,
const labelList master 
)
inline

Construct from components.

Definition at line 44 of file objectMapI.H.

objectMap ( Istream is)
inline

Construct from Istream.

Definition at line 51 of file objectMapI.H.

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


Member Function Documentation

label & index ( )
inline

Return object index.

Definition at line 68 of file objectMapI.H.

label index ( ) const
inline

Definition at line 74 of file objectMapI.H.

labelList & masterObjects ( )
inline

Return master object index.

Definition at line 80 of file objectMapI.H.

const labelList & masterObjects ( ) const
inline

Definition at line 86 of file objectMapI.H.


Friends And Related Function Documentation

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

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