Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
CaeUnsGridModel Class Reference

The unstructured grid model class. More...

#include <CaeUnsGridModel.h>

+ Inheritance diagram for CaeUnsGridModel:
+ Collaboration diagram for CaeUnsGridModel:

Public Member Functions

bool appendEnumElementOrder (PWGM_ENUM_ELEMORDER order) const
 Append an element type to the current face streaming order. More...
 
 CaeUnsGridModel (PWGM_HGRIDMODEL model)
 Constructor. More...
 
 CaeUnsGridModel (const CaeUnsGridModel &src)
 Copy constructor. More...
 
bool customIndexSchemeReady (CaeUnsCustomIndexHandler &handler) const
 Notify export framework that custom index mapper is ready for use. More...
 
PWP_VOID defaultEnumElementOrder () const
 Reset to the default element type order. More...
 
CaeUnsGridModeloperator= (const CaeUnsGridModel &rhs)
 Assignment operator. More...
 
PWP_UINT32 patchCount () const
 Get the number of boundary patches in the model. More...
 
bool streamFaces (PWGM_ENUM_FACEORDER order, CaeFaceStreamHandler &handler) const
 Initiate ordered face streaming to the given handler. More...
 
PWP_UINT32 vertexCount () const
 Get the number of unstructured vertices in the model. More...
 
virtual ~CaeUnsGridModel ()
 Destructor. More...
 
- Public Member Functions inherited from CaeGridModel
PWP_UINT32 blockCount () const
 Get the number of blocks in the model. More...
 
template<typename T >
bool getAttribute (const char *name, T &val) const
 Templated method that gets the value of a published plugin attribute. More...
 
 operator PWGM_HGRIDMODEL () const
 The PWGM_HGRIDMODEL cast operator. More...
 
CaeGridModeloperator= (const CaeGridModel &rhs)
 The assignment operator. More...
 
bool getAttribute (const char *name, const char *&val, const char *defVal) const
 
bool getAttribute (const char *name, PWP_UINT &val, PWP_UINT defVal) const
 
bool getAttribute (const char *name, PWP_UINT32 &val, PWP_UINT32 defVal) const
 
bool getAttribute (const char *name, PWP_INT &val, PWP_INT defVal) const
 
bool getAttribute (const char *name, PWP_INT32 &val, PWP_INT32 defVal) const
 
bool getAttribute (const char *name, PWP_REAL &val, PWP_REAL defVal) const
 
bool getAttribute (const char *name, PWP_FLOAT &val, PWP_FLOAT defVal) const
 
bool getAttribute (const char *name, bool &val, bool defVal) const
 
bool getAttributeEnum (const char *name, const char *&val, const char *defVal) const
 
- Public Member Functions inherited from CaeUnsElementGroup
PWP_UINT32 elementCount (PWGM_ELEMCOUNTS *pDetails=0) const
 Get the number of elements in the group. More...
 
PWGM_HELEMENT enumElements (PWP_UINT32 ndx) const
 Get an element in the group. More...
 
PWGM_HELEMENT firstElement () const
 Get the first element in the group. More...
 
virtual ~CaeUnsElementGroup ()
 Destructor. More...
 

Static Public Member Functions

static const char * elemTypeStr (PWGM_ENUM_ELEMTYPE type)
 Maps an element type id to a string value. More...
 
static const char * faceOrderStr (PWGM_ENUM_FACEORDER order)
 Maps a face order id to a string value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CaeGridModel
 CaeGridModel (PWGM_HGRIDMODEL model)
 Constructor. More...
 
 CaeGridModel (const CaeGridModel &src)
 Copy constructor. More...
 
 ~CaeGridModel ()
 Destructor. More...
 
- Protected Member Functions inherited from CaeUnsElementGroup
virtual PWP_UINT32 elementCountImpl (PWGM_ELEMCOUNTS *pDetails) const =0
 Get the number of elements in the group. More...
 
virtual PWGM_HELEMENT enumElementsImpl (PWP_UINT32 ndx) const =0
 Get an element in the group. More...
 
- Protected Attributes inherited from CaeGridModel
PWGM_HGRIDMODEL model_
 The bound PWGM_HGRIDMODEL. More...
 

Detailed Description

The unstructured grid model class.

Provides read only access to an unstructured grid model.

hierarchy-uns.png
Unstructured Grid Model Data Hierarchy

Definition at line 176 of file CaeUnsGridModel.h.

Constructor & Destructor Documentation

CaeUnsGridModel::CaeUnsGridModel ( PWGM_HGRIDMODEL  model)

Constructor.

Parameters
modelThe model handle to bind.
See Also
CaeStrGridModel

Definition at line 22 of file CaeUnsGridModel.cxx.

CaeUnsGridModel::CaeUnsGridModel ( const CaeUnsGridModel src)

Copy constructor.

Binds this model to the same model as src.

Parameters
srcAn unstructured grid model instance.

Definition at line 27 of file CaeUnsGridModel.cxx.

CaeUnsGridModel::~CaeUnsGridModel ( )
virtual

Destructor.

Definition at line 32 of file CaeUnsGridModel.cxx.

Member Function Documentation

bool CaeUnsGridModel::appendEnumElementOrder ( PWGM_ENUM_ELEMORDER  order) const

Append an element type to the current face streaming order.

Parameters
orderThe element order flag.
Returns
true if appended successfully.
See Also
defaultEnumElementOrder()

Definition at line 97 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_, and PwModAppendEnumElementOrder().

bool CaeUnsGridModel::customIndexSchemeReady ( CaeUnsCustomIndexHandler handler) const

Notify export framework that custom index mapper is ready for use.

Parameters
handlerThe index mapper handler.
Returns
true on success.
Note
Usually, the handler is your plugin's subclass. However, any CaeUnsCustomIndexHandler subclass can be used.

Definition at line 89 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_, ndxMapperCB(), and PwModCustomIndexSchemeReady().

PWP_VOID CaeUnsGridModel::defaultEnumElementOrder ( ) const

Reset to the default element type order.

See Also
appendEnumElementOrder()

Definition at line 103 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_, and PwModDefaultEnumElementOrder().

static const char* CaeUnsGridModel::elemTypeStr ( PWGM_ENUM_ELEMTYPE  type)
inlinestatic

Maps an element type id to a string value.

Definition at line 252 of file CaeUnsGridModel.h.

References PwElemTypeToText().

static const char* CaeUnsGridModel::faceOrderStr ( PWGM_ENUM_FACEORDER  order)
inlinestatic

Maps a face order id to a string value.

Definition at line 247 of file CaeUnsGridModel.h.

References PwFaceOrderToText().

CaeUnsGridModel & CaeUnsGridModel::operator= ( const CaeUnsGridModel rhs)

Assignment operator.

Definition at line 109 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_.

PWP_UINT32 CaeUnsGridModel::patchCount ( ) const

Get the number of boundary patches in the model.

The elements of a patch all share the same boundary condition.

See Also
CaeUnsPatch

Definition at line 37 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_, and PwModDomainCount().

bool CaeUnsGridModel::streamFaces ( PWGM_ENUM_FACEORDER  order,
CaeFaceStreamHandler handler 
) const

Initiate ordered face streaming to the given handler.

Parameters
orderThe face stream order.
handlerThe face stream handler.
Returns
true if streaming completes successfully.
Note
Usually, the handler is your plugin's subclass. However, any CaeFaceStreamHandler subclass can be used.

Definition at line 72 of file CaeUnsGridModel.cxx.

References beginCB(), endCB(), faceCB(), CaeGridModel::model_, and PwModStreamFaces().

PWP_UINT32 CaeUnsGridModel::vertexCount ( ) const

Get the number of unstructured vertices in the model.

See Also
CaeUnsVertex

Definition at line 43 of file CaeUnsGridModel.cxx.

References CaeGridModel::model_, and PwModVertexCount().


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