ElemID Class Reference

A reference to an element. More...

#include <ParFUM_Types.h>

Collaboration diagram for ElemID:

[legend]

Public Member Functions
	ElemID ()
	default constructor
	ElemID (int _type, int _id)
	constructor - initializer
bool	operator== (const ElemID &rhs) const
bool	operator< (const ElemID &rhs) const
const ElemID &	operator= (const ElemID &rhs)
virtual void	pup (PUP::er &p)
int	getSignedId ()
int	getSignedType ()
int	getUnsignedType ()
	Return the element's type.
Static Public Member Functions
static ElemID	createNodeID (int type, int node)
Data Fields
int	type
	type is negative for ghost elements
int	id
	id refers to the index in the entity list

---

Detailed Description

A reference to an element.

Ghost indices are handled correctly here

Definition at line 13 of file ParFUM_Types.h.

---

Constructor & Destructor Documentation

ElemID::ElemID

(

)

[inline]

default constructor

Definition at line 21 of file ParFUM_Types.h.

References type.

ElemID::ElemID	(	int	_type,
		int	_id
	)			[inline]

constructor - initializer

Definition at line 26 of file ParFUM_Types.h.

References type.

---

Member Function Documentation

bool ElemID::operator==

(

const ElemID &

rhs

)

const [inline]

Definition at line 36 of file ParFUM_Types.h.

References id, and type.

bool ElemID::operator<

(

const ElemID &

rhs

)

const [inline]

Definition at line 39 of file ParFUM_Types.h.

References id, and type.

const ElemID& ElemID::operator=

(

const ElemID &

rhs

)

[inline]

Definition at line 42 of file ParFUM_Types.h.

References id, and type.

virtual void ElemID::pup

(

PUP::er &

p

)

[inline, virtual]

Definition at line 47 of file ParFUM_Types.h.

References id, and type.

static ElemID ElemID::createNodeID	(	int	type,
		int	node
	)			[inline, static]

Definition at line 52 of file ParFUM_Types.h.

int ElemID::getSignedId

(

)

[inline]

Definition at line 56 of file ParFUM_Types.h.

References id, and type.

Referenced by meshNodeElemItr_GetCurr(), and topNodeElemItr_GetCurr().

Here is the caller graph for this function:

int ElemID::getSignedType

(

)

[inline]

Definition at line 62 of file ParFUM_Types.h.

References type.

int ElemID::getUnsignedType

(

)

[inline]

Return the element's type.

This is necessary because the type member itself is negative for ghosts(for some stupid reason)

Definition at line 66 of file ParFUM_Types.h.

References type.

Referenced by meshNodeElemItr_GetCurr(), and topNodeElemItr_GetCurr().

Here is the caller graph for this function:

---

Field Documentation

int ElemID::type

type is negative for ghost elements

Definition at line 16 of file ParFUM_Types.h.

Referenced by ElemID(), getSignedId(), getSignedType(), getUnsignedType(), meshElemItr_GetCurr(), meshFacetItr_Begin(), meshFacetItr_GetCurr(), meshFacetItr_Next(), meshModel_GetElemAtId(), meshNodeElemItr_GetCurr(), operator<(), operator=(), operator==(), and pup().

int ElemID::id

id refers to the index in the entity list

Definition at line 18 of file ParFUM_Types.h.

Referenced by getSignedId(), meshElemItr_GetCurr(), meshFacetItr_Begin(), meshFacetItr_GetCurr(), meshFacetItr_Next(), meshModel_GetElemAtId(), meshNodeElemItr_GetCurr(), operator<(), operator=(), operator==(), and pup().

---

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

• libs/ck-libs/ParFUM/ParFUM_Types.h