Loading...
Searching...
No Matches
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 <objectMap.H>

Public Member Functions

 objectMap () noexcept
 Default construct, with index=-1 and no objects.
 objectMap (const label index, const labelUList &master)
 Copy construct from components.
 objectMap (const label index, labelList &&master)
 Move construct from components.
 objectMap (Istream &is)
 Construct from Istream.
bool empty () const noexcept
 True if there are no objects.
label size () const noexcept
 The number of objects.
label & index () noexcept
 The object index.
label index () const noexcept
 The object index.
labelList & masterObjects () noexcept
 The master object indices.
const labelList & masterObjects () const noexcept
 The master object indices.

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

Constructor & Destructor Documentation

◆ objectMap() [1/4]

objectMap ( )
inlinenoexcept

Default construct, with index=-1 and no objects.

Definition at line 78 of file objectMap.H.

References Foam::noexcept.

Referenced by operator!=, operator<<, operator==, and operator>>.

Here is the caller graph for this function:

◆ objectMap() [2/4]

objectMap ( const label index,
const labelUList & master )
inline

Copy construct from components.

Definition at line 25 of file objectMapI.H.

References index().

Here is the call graph for this function:

◆ objectMap() [3/4]

objectMap ( const label index,
labelList && master )
inline

Move construct from components.

Definition at line 32 of file objectMapI.H.

References index().

Here is the call graph for this function:

◆ objectMap() [4/4]

objectMap ( Istream & is)
inlineexplicit

Construct from Istream.

Definition at line 39 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

◆ empty()

bool empty ( ) const
inlinenoexcept

True if there are no objects.

Definition at line 101 of file objectMap.H.

References Foam::noexcept.

◆ size()

label size ( ) const
inlinenoexcept

The number of objects.

Definition at line 106 of file objectMap.H.

References Foam::noexcept.

◆ index() [1/2]

label & index ( )
inlinenoexcept

The object index.

Definition at line 111 of file objectMap.H.

References Foam::noexcept.

Referenced by objectMap(), and objectMap().

Here is the caller graph for this function:

◆ index() [2/2]

label index ( ) const
inlinenoexcept

The object index.

Definition at line 116 of file objectMap.H.

References Foam::noexcept.

◆ masterObjects() [1/2]

labelList & masterObjects ( )
inlinenoexcept

The master object indices.

Definition at line 121 of file objectMap.H.

References Foam::noexcept.

◆ masterObjects() [2/2]

const labelList & masterObjects ( ) const
inlinenoexcept

The master object indices.

Definition at line 126 of file objectMap.H.

References Foam::noexcept.

◆ operator==

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

References b, and objectMap().

◆ operator!=

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

References b, and objectMap().

◆ operator<<

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

References objectMap().

◆ operator>>

Istream & operator>> ( Istream & ,
objectMap &  )
friend

References objectMap().

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