The model unstructured element data class. More...

#include <CaeUnsElement.h>

Inheritance diagram for CaeUnsEnumElementData:

Collaboration diagram for CaeUnsEnumElementData:

Public Member Functions
PWGM_HELEMENT &	blockElement ()
	Gets a non-const ref to the owning block's element handle. More...

const PWGM_HELEMENT &	blockElement () const
	Gets a const ref to the owning block's element handle. More...

PWP_UINT32	blockId () const
	Gets the id (index) of the element's owning block. More...

	CaeUnsEnumElementData ()
	Default constructor. More...

	CaeUnsEnumElementData (const CaeUnsEnumElementData &src)
	Copy constructor. More...

	CaeUnsEnumElementData (const PWGM_ENUMELEMDATA &eed)
	Cast/Copy constructor. More...

PWGM_ENUMELEMDATA &	enumElementData ()
	Gets a non-const ref to the underlying PWGM_ENUMELEMDATA struct. More...

const PWGM_ENUMELEMDATA &	enumElementData () const
	Gets a const ref to the underlying PWGM_ENUMELEMDATA struct. More...

	operator const PWGM_ENUMELEMDATA & () const
	Const PWGM_ENUMELEMDATA casting operator. More...

	operator const PWGM_HELEMENT & () const
	Const PWGM_HELEMENT casting operator. More...

	operator PWGM_ENUMELEMDATA & ()
	Non-const PWGM_ENUMELEMDATA casting operator. More...

	operator PWGM_HELEMENT & ()
	Non-const PWGM_HELEMENT casting operator. More...

CaeUnsEnumElementData &	operator= (const CaeUnsEnumElementData &src)
	Assignment operator. More...

CaeUnsEnumElementData &	operator= (const PWGM_ENUMELEMDATA &eed)
	Assignment operator. More...

	~CaeUnsEnumElementData ()
	Destructor. More...

Public Member Functions inherited from CaeUnsElementData
	CaeUnsElementData ()
	Default constructor. More...

	CaeUnsElementData (const CaeUnsElementData &src)
	Copy constructor. More...

	CaeUnsElementData (const PWGM_ELEMDATA &ed)
	Cast/Copy constructor. More...

PWGM_ELEMDATA &	elementData ()
	Gets a non-const ref to the underlying PWGM_ELEMDATA struct. More...

const PWGM_ELEMDATA &	elementData () const
	Gets a const ref to the underlying PWGM_ELEMDATA struct. More...

PWP_UINT32	indexAt (PWP_UINT32 ndx) const
	Gets the global index of ndx'th vertex. More...

bool	isOfType (ElementType type) const
	Returns true if element is of the specified ElementType. More...

bool	isOfType (PWGM_ENUM_ELEMTYPE type) const
	Returns true if element is of the specified PWGM_ENUM_ELEMTYPE. More...

bool	isValid () const
	Returns true if element type is not Invalid. More...

	operator const PWGM_ELEMDATA & () const
	Const PWGM_ELEMDATA casting operator. More...

	operator PWGM_ELEMDATA & ()
	Non-const PWGM_ELEMDATA casting operator. More...

CaeUnsElementData &	operator= (const CaeUnsElementData &src)
	Assignment operator. More...

CaeUnsElementData &	operator= (const PWGM_ELEMDATA &ed)
	Assignment operator. More...

ElementType	type () const
	Gets the element type. More...

PWGM_HVERTEX	vertAt (PWP_UINT32 ndx) const
	Gets the handle of ndx'th vertex. More...

PWP_UINT32	vertCount () const
	Gets the number of vertices in the element. More...

	~CaeUnsElementData ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from CaeUnsElementData
enum	ElementType { Bar = PWGM_ELEMTYPE_BAR, Hex = PWGM_ELEMTYPE_HEX, Quad = PWGM_ELEMTYPE_QUAD, Tri = PWGM_ELEMTYPE_TRI, Tet = PWGM_ELEMTYPE_TET, Wedge = PWGM_ELEMTYPE_WEDGE, Pyramid = PWGM_ELEMTYPE_PYRAMID, Point = PWGM_ELEMTYPE_POINT, NumTypes = PWGM_ELEMTYPE_SIZE, LastType = NumTypes - 1, Invalid = NumTypes }
	The valid element type id values. More...

Static Public Attributes inherited from CaeUnsElementData
static const PWP_UINT32	MaxNumVerts = 8
	The maximum number of vertices per element. More...

Protected Member Functions inherited from CaeUnsElementData
	CaeUnsElementData (const PWGM_ELEMDATA &ed, const PWGM_HELEMENT &he)
	Protected constructor used by the CaeUnsEnumElementData subclass. More...

Protected Attributes inherited from CaeUnsElementData
PWGM_ENUMELEMDATA	eed_
	The element data. More...

Detailed Description

The model unstructured element data class.

The CaeUnsEnumElementData class represents the data available for an unstructured grid model element. This class's data is populated with a call to one of the overloaded CaeUnsElement::data() methods. Grid model element indices are consistent with the owner/neighbor cell indices returned by the CaeFaceStreamHandler interface.

This class is equivalent to CaeUnsElementData with the addition of information about the block that owns this element.

See also: CaeUnsElement::data(), CaeUnsElementData, PWGM_ENUMELEMDATA, CaeFaceStreamHandler::streamFace(), PWGM_FACESTREAM_DATA

Sample Usage:: // Iterate all elements in model_ grouped by VC.

model_.appendEnumElementOrder(PWGM_ELEMORDER_VC);

CaeUnsEnumElementData eed;

CaeUnsElement elem(model_);

while (elem.isValid()) {

std::cout << "element: " << elem.index() << std::endl;

if (elem.data(eed)) {

std::cout << "block: " << eed.blockId() << std::endl;

std::cout << "type: " << eed.type() << std::endl;

std::cout << "vertCnt: " << eed.vertCount() << std::endl;

for (PWP_UINT32 ii = 0; ii < eed.vertCount(); ++ii) {

std::cout << " index[" << ii << "]:" << eed.indexAt(ii) << std::endl;

}

}

++elem;

}

Definition at line 287 of file CaeUnsElement.h.

Constructor & Destructor Documentation

◆ CaeUnsEnumElementData() [1/3]

CaeUnsEnumElementData::CaeUnsEnumElementData ( )

inline

Default constructor.

Constructs an invalid element data object.

See also: CaeUnsElement::data()

Definition at line 295 of file CaeUnsElement.h.

◆ CaeUnsEnumElementData() [2/3]

CaeUnsEnumElementData::CaeUnsEnumElementData ( const CaeUnsEnumElementData & src )

inline

Copy constructor.

Definition at line 302 of file CaeUnsElement.h.

◆ CaeUnsEnumElementData() [3/3]

CaeUnsEnumElementData::CaeUnsEnumElementData ( const PWGM_ENUMELEMDATA & eed )

inline

Cast/Copy constructor.

Definition at line 309 of file CaeUnsElement.h.

◆ ~CaeUnsEnumElementData()

CaeUnsEnumElementData::~CaeUnsEnumElementData ( )

inline

Destructor.

Definition at line 316 of file CaeUnsElement.h.

Member Function Documentation

◆ blockElement() [1/2]

PWGM_HELEMENT& CaeUnsEnumElementData::blockElement ( )

inline

Gets a non-const ref to the owning block's element handle.

Definition at line 353 of file CaeUnsElement.h.

References CaeUnsElementData::eed_, and PWGM_ENUMELEMDATA::hBlkElement.

◆ blockElement() [2/2]

const PWGM_HELEMENT& CaeUnsEnumElementData::blockElement ( ) const

inline

Gets a const ref to the owning block's element handle.

Definition at line 360 of file CaeUnsElement.h.

References CaeUnsElementData::eed_, and PWGM_ENUMELEMDATA::hBlkElement.

◆ blockId()

PWP_UINT32 CaeUnsEnumElementData::blockId ( ) const

inline

Gets the id (index) of the element's owning block.

This index can be used to construct an unstructured block object.

See also: CaeUnsBlock

Sample Usage:: CaeUnsElement elem(model_);

while (elem.isValid()) {

CaeUnsBlock blk(model_, elem.blockId());

// blk is now valid

++elem;

}

Definition at line 380 of file CaeUnsElement.h.

References CaeUnsElementData::eed_, PWGM_ENUMELEMDATA::hBlkElement, and PWGM_HELEMENT_PID.

◆ enumElementData() [1/2]

PWGM_ENUMELEMDATA& CaeUnsEnumElementData::enumElementData ( )

inline

Gets a non-const ref to the underlying PWGM_ENUMELEMDATA struct.

Definition at line 339 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

◆ enumElementData() [2/2]

const PWGM_ENUMELEMDATA& CaeUnsEnumElementData::enumElementData ( ) const

inline

Gets a const ref to the underlying PWGM_ENUMELEMDATA struct.

Definition at line 346 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

◆ operator const PWGM_ENUMELEMDATA &()

CaeUnsEnumElementData::operator const PWGM_ENUMELEMDATA & ( ) const

inline

Const PWGM_ENUMELEMDATA casting operator.

Definition at line 394 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

◆ operator const PWGM_HELEMENT &()

CaeUnsEnumElementData::operator const PWGM_HELEMENT & ( ) const

inline

Const PWGM_HELEMENT casting operator.

Definition at line 408 of file CaeUnsElement.h.

References CaeUnsElementData::eed_, and PWGM_ENUMELEMDATA::hBlkElement.

◆ operator PWGM_ENUMELEMDATA &()

CaeUnsEnumElementData::operator PWGM_ENUMELEMDATA & ( )

inline

Non-const PWGM_ENUMELEMDATA casting operator.

Definition at line 387 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

◆ operator PWGM_HELEMENT &()

CaeUnsEnumElementData::operator PWGM_HELEMENT & ( )

inline

Non-const PWGM_HELEMENT casting operator.

Definition at line 401 of file CaeUnsElement.h.

References CaeUnsElementData::eed_, and PWGM_ENUMELEMDATA::hBlkElement.

◆ operator=() [1/2]

CaeUnsEnumElementData& CaeUnsEnumElementData::operator= ( const CaeUnsEnumElementData & src )

inline

Assignment operator.

Definition at line 322 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

◆ operator=() [2/2]

CaeUnsEnumElementData& CaeUnsEnumElementData::operator= ( const PWGM_ENUMELEMDATA & eed )

inline

Assignment operator.

Definition at line 331 of file CaeUnsElement.h.

References CaeUnsElementData::eed_.

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

CaeUnsElement.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaeUnsEnumElementData() [1/3]

◆ CaeUnsEnumElementData() [2/3]

◆ CaeUnsEnumElementData() [3/3]

◆ ~CaeUnsEnumElementData()

Member Function Documentation

◆ blockElement() [1/2]

◆ blockElement() [2/2]

◆ blockId()

◆ enumElementData() [1/2]

◆ enumElementData() [2/2]

◆ operator const PWGM_ENUMELEMDATA &()

◆ operator const PWGM_HELEMENT &()

◆ operator PWGM_ENUMELEMDATA &()

◆ operator PWGM_HELEMENT &()

◆ operator=() [1/2]

◆ operator=() [2/2]