The structured grid model class. More...

#include <CaeStrGridModel.h>

Inheritance diagram for CaeStrGridModel:

Collaboration diagram for CaeStrGridModel:

Public Member Functions
	CaeStrGridModel (const CaeStrGridModel &src)
	Copy constructor. More...

	CaeStrGridModel (PWGM_HGRIDMODEL model)
	Constructor. More...

bool	customIndexSchemeReady (CaeStrCustomIndexHandler &handler) const
	Notify export framework that custom index mapper is ready for use. More...

virtual	~CaeStrGridModel ()
	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...

CaeGridModel &	operator= (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 CaeStrConnectionGroup
PWP_UINT32	connectionCount () const
	Get the number of connections in the group. More...

PWGM_HCNXN	enumConnections (PWP_UINT32 ndx) const
	Get an connection in the group. More...

PWGM_HCNXN	firstConnection () const
	Get the first connection in the group. More...

virtual	~CaeStrConnectionGroup ()
	Destructor. More...

Public Member Functions inherited from CaeStrBoundaryGroup
PWP_UINT32	boundaryCount () const
	Get the number of boundaries in the group. More...

PWGM_HBNDRY	enumBoundaries (PWP_UINT32 ndx) const
	Get a boundary in the group. More...

PWGM_HBNDRY	firstBoundary () const
	Get the first boundary in the group. More...

virtual	~CaeStrBoundaryGroup ()
	Destructor. More...

Static Public Member Functions
static bool	inRange (const PWGM_INDEX3 &ijk, const PWGM_STR_RANGE &range)
	Determines if an ijk index is within a given min/max range. More...

static PWGM_INDEX3	xform2Apply (const PWGM_INDEX_XFORM2 &x2, const PWGM_INDEX3 &ijk)
	Apply a transform to an ij connection index. More...

static PWGM_ENUM_IJK	xform2Follows (const PWGM_INDEX_XFORM2 &x2, PWGM_ENUM_IJK localAxis, bool *pFlipped=0)
	Determines which axes are parallel in a transformed ij system. More...

static bool	xform2to3 (const PWGM_INDEX_XFORM2 &x2, PWGM_INDEX_XFORM &x3)
	Up converts an ij transform to an equivalent ijk transform. More...

static bool	xform3to2 (const PWGM_INDEX_XFORM &x3, PWGM_INDEX_XFORM2 &x2)
	Down converts a ijk transform to an equivalent ij transform. More...

static PWGM_INDEX3	xformApply (const PWGM_INDEX_XFORM &x3, const PWGM_INDEX3 &ijk)
	Apply an ijk transform to an ijk connection index. More...

static PWGM_ENUM_IJK	xformFollows (const PWGM_INDEX_XFORM &x3, PWGM_ENUM_IJK localAxis, bool *pFlipped=0)
	Determines which axes are parallel in a transformed ijk system. More...

Additional Inherited Members
Protected Member Functions inherited from CaeGridModel
	CaeGridModel (const CaeGridModel &src)
	Copy constructor. More...

	CaeGridModel (PWGM_HGRIDMODEL model)
	Constructor. More...

	~CaeGridModel ()
	Destructor. More...

Protected Member Functions inherited from CaeStrConnectionGroup
virtual PWP_UINT32	connectionCountImpl () const =0
	Get the number of connections in the group. More...

virtual PWGM_HCNXN	enumConnectionsImpl (PWP_UINT32 ndx) const =0
	Get a connection in the group. More...

Protected Member Functions inherited from CaeStrBoundaryGroup
virtual PWP_UINT32	boundaryCountImpl () const =0
	Get the number of boundaries in the group. More...

virtual PWGM_HBNDRY	enumBoundariesImpl (PWP_UINT32 ndx) const =0
	Get a boundary in the group. More...

Protected Attributes inherited from CaeGridModel
PWGM_HGRIDMODEL	model_
	The bound PWGM_HGRIDMODEL. More...

Detailed Description

The structured grid model class.

Provides read only access to a structured grid model.

Structured Grid Model Data Hierarchy

Definition at line 65 of file CaeStrGridModel.h.

Constructor & Destructor Documentation

◆ CaeStrGridModel() [1/2]

CaeStrGridModel::CaeStrGridModel ( PWGM_HGRIDMODEL model )

Constructor.

Parameters

model The model handle to bind.

See also: CaeStrGridModel

Definition at line 22 of file CaeStrGridModel.cxx.

◆ CaeStrGridModel() [2/2]

CaeStrGridModel::CaeStrGridModel ( const CaeStrGridModel & src )

Copy constructor.

Binds this model to the same model as src.

Parameters

src	A structured grid model instance.

Definition at line 27 of file CaeStrGridModel.cxx.

◆ ~CaeStrGridModel()

CaeStrGridModel::~CaeStrGridModel ( )

virtual

Destructor.

Definition at line 32 of file CaeStrGridModel.cxx.

Member Function Documentation

◆ customIndexSchemeReady()

bool CaeStrGridModel::customIndexSchemeReady ( CaeStrCustomIndexHandler & handler ) const

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

Parameters

handler The index mapper handler.

Returns: true on success.

Note: Usually, the handler is your plugin's subclass. However, any CaeStrCustomIndexHandler subclass can be used.

Definition at line 46 of file CaeStrGridModel.cxx.

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

◆ inRange()

bool CaeStrGridModel::inRange	(	const PWGM_INDEX3 &	ijk,
		const PWGM_STR_RANGE &	range
	)

static

Determines if an ijk index is within a given min/max range.

An index is considered in a range if it is internal to or is on the boundary of the range.

Parameters

ijk	The index to test.
range	The min/max range.

Returns: true if index is internal to or is on the boundary of the range.

Definition at line 102 of file CaeStrGridModel.cxx.

References PwInRange().

◆ xform2Apply()

PWGM_INDEX3 CaeStrGridModel::xform2Apply	(	const PWGM_INDEX_XFORM2 &	x2,
		const PWGM_INDEX3 &	ijk
	)

static

Apply a transform to an ij connection index.

Transforms a block connection ij index to a connected block's equivalent ij connection index.

Parameters

x2	The ij transform.
ijk	The connection index to transform.

Returns: The transformed connection index.

Note: Transforms are only meaningful when applied to connection indices.

Definition at line 83 of file CaeStrGridModel.cxx.

References PwXform2Apply().

◆ xform2Follows()

PWGM_ENUM_IJK CaeStrGridModel::xform2Follows	(	const PWGM_INDEX_XFORM2 &	x2,
		PWGM_ENUM_IJK	localAxis,
		bool *	pFlipped = `0`
	)

static

Determines which axes are parallel in a transformed ij system.

Determine which transformed ij axis is parallel to a given local ij axis. The axis directions can be opposite.

Parameters

x2	The ij transform.
localAxis	The local i or j axis id.
pFlipped	Pointer to a boolean. Set true if the local and transformed axes have opposite directions.

Returns: The transformed index.

Definition at line 90 of file CaeStrGridModel.cxx.

References PwXform2Follows().

◆ xform2to3()

bool CaeStrGridModel::xform2to3	(	const PWGM_INDEX_XFORM2 &	x2,
		PWGM_INDEX_XFORM &	x3
	)

static

Up converts an ij transform to an equivalent ijk transform.

No information is lost by the conversion.

Parameters

x2	The ij transform.
x3	The converted ijk transform.

Returns: true if successful.

Definition at line 53 of file CaeStrGridModel.cxx.

References PwXform2to3().

◆ xform3to2()

bool CaeStrGridModel::xform3to2	(	const PWGM_INDEX_XFORM &	x3,
		PWGM_INDEX_XFORM2 &	x2
	)

static

Down converts a ijk transform to an equivalent ij transform.

Information is lost by the conversion.

Parameters

x3	The ijk transform.
x2	The converted ij transform.

Returns: true if successful.

Definition at line 59 of file CaeStrGridModel.cxx.

References PwXform3to2().

◆ xformApply()

PWGM_INDEX3 CaeStrGridModel::xformApply	(	const PWGM_INDEX_XFORM &	x3,
		const PWGM_INDEX3 &	ijk
	)

static

Apply an ijk transform to an ijk connection index.

Transforms a block connection ijk index to a connected block's equivalent ijk connection index.

Parameters

x3	The ijk transform.
ijk	The connection index to transform.

Returns: The transformed connection index.

Note: Transforms are only meaningful when applied to connection indices.

Definition at line 65 of file CaeStrGridModel.cxx.

References PwXformApply().

◆ xformFollows()

PWGM_ENUM_IJK CaeStrGridModel::xformFollows	(	const PWGM_INDEX_XFORM &	x3,
		PWGM_ENUM_IJK	localAxis,
		bool *	pFlipped = `0`
	)

static

Determines which axes are parallel in a transformed ijk system.

Determine which transformed ijk axis is parallel to a given local ijk axis. The axis directions can be opposite.

Parameters

x3	The ijk transform.
localAxis	The local i, j, or k axis id.
pFlipped	Pointer to a boolean. Set true if the local and transformed axes have opposite directions.

Returns: The transformed index.

Definition at line 71 of file CaeStrGridModel.cxx.

References PwXformFollows().

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaeStrGridModel() [1/2]

◆ CaeStrGridModel() [2/2]

◆ ~CaeStrGridModel()

Member Function Documentation

◆ customIndexSchemeReady()

◆ inRange()

◆ xform2Apply()

◆ xform2Follows()

◆ xform2to3()

◆ xform3to2()

◆ xformApply()

◆ xformFollows()