Pointwise Plugin SDK
Functions
+ Collaboration diagram for Structured Grid Export Utility Functions:

Functions

PWP_BOOL PwInRange (PWGM_INDEX3 ijk, const PWGM_STR_RANGE *pRange)
 Determines if an PWGM_INDEX3 is within a PWGM_STR_RANGE. More...
 
PWGM_INDEX3 PwXform2Apply (const PWGM_INDEX_XFORM2 *pX2, PWGM_INDEX3 ijk)
 Apply a PWGM_INDEX_XFORM2 transform to a PWGM_INDEX3 value. More...
 
PWGM_ENUM_IJK PwXform2Follows (const PWGM_INDEX_XFORM2 *pX2, PWGM_ENUM_IJK localAxis, PWP_BOOL *pFlipped)
 For a given localAxis, determine the corresponding axis in the transformed system. More...
 
PWP_BOOL PwXform2to3 (const PWGM_INDEX_XFORM2 *pX2, PWGM_INDEX_XFORM *pX3)
 Convert a 2D transform matrix to it's 3D equivalent. More...
 
PWP_BOOL PwXform3to2 (const PWGM_INDEX_XFORM *pX3, PWGM_INDEX_XFORM2 *pX2)
 Convert a 3D transform matrix to it's 2D equivalent. More...
 
PWGM_INDEX3 PwXformApply (const PWGM_INDEX_XFORM *pX3, PWGM_INDEX3 ijk)
 Apply a PWGM_INDEX_XFORM transform to a PWGM_INDEX3 value. More...
 
PWGM_ENUM_IJK PwXformFollows (const PWGM_INDEX_XFORM *pX3, PWGM_ENUM_IJK localAxis, PWP_BOOL *pFlipped)
 For a given localAxis, determine the corresponding axis in the transformed system. More...
 

Detailed Description

These utility functions are ONLY used to access structured grid models. These functions are defined locally and do NOT get routed to the framework.

Function Documentation

◆ PwInRange()

PWP_BOOL PwInRange ( PWGM_INDEX3  ijk,
const PWGM_STR_RANGE pRange 
)

Determines if an PWGM_INDEX3 is within a PWGM_STR_RANGE.

Parameters
ijkThe PWGM_INDEX3 value to check.
pRangeConst pointer to the PWGM_STR_RANGE.
Returns
PWP_TRUE if ijk resides within the limits of pRange.

Definition at line 753 of file apiGridModel.cxx.

References PWGM_STR_RANGE::beg, PWGM_STR_RANGE::end, PWGM_INDEX3::i, PWGM_INDEX3::j, and PWGM_INDEX3::k.

Referenced by CaeStrGridModel::inRange().

◆ PwXform2Apply()

PWGM_INDEX3 PwXform2Apply ( const PWGM_INDEX_XFORM2 pX2,
PWGM_INDEX3  ijk 
)

Apply a PWGM_INDEX_XFORM2 transform to a PWGM_INDEX3 value.

Parameters
pX2Const pointer to the PWGM_INDEX_XFORM2.
ijkThe PWGM_INDEX3 value to transform. It will not be changed.
Returns
The transformed PWGM_INDEX3 value. Only the i and j values will be transformed. The k value will not be changed.

Definition at line 729 of file apiGridModel.cxx.

References PWGM_INDEX3::i, PWGM_INDEX3::j, PWGM_INDEX3::k, and PWGM_INDEX_XFORM2::m.

Referenced by CaeStrGridModel::xform2Apply().

◆ PwXform2Follows()

PWGM_ENUM_IJK PwXform2Follows ( const PWGM_INDEX_XFORM2 pX2,
PWGM_ENUM_IJK  localAxis,
PWP_BOOL pFlipped 
)

For a given localAxis, determine the corresponding axis in the transformed system.

Parameters
pX2Const pointer to the PWGM_INDEX_XFORM2.
localAxisThe local axis of interest.
pFlippedFlag set to PWP_TRUE if the returned axis direction is the opposite of localAxis. Pointer may be NULL.
Returns
The corresponding axis in the transformed system.

Definition at line 740 of file apiGridModel.cxx.

References PwXform2to3(), and PwXformFollows().

Referenced by CaeStrGridModel::xform2Follows().

◆ PwXform2to3()

PWP_BOOL PwXform2to3 ( const PWGM_INDEX_XFORM2 pX2,
PWGM_INDEX_XFORM pX3 
)

Convert a 2D transform matrix to it's 3D equivalent.

Parameters
pX2Const pointer to a PWGM_INDEX_XFORM2 input buffer.
pX3Pointer to a PWGM_INDEX_XFORM output buffer.
The matrix mapping:
XFORM2 XFORM
------ -------
A B C A B 0 C
D E F ==> D E 0 F
0 0 1 0
Returns
PWP_TRUE on success.

Definition at line 618 of file apiGridModel.cxx.

References PWGM_INDEX_XFORM::m, PWGM_INDEX_XFORM2::m, PWP_FALSE, and PWP_TRUE.

Referenced by PwXform2Follows(), and CaeStrGridModel::xform2to3().

◆ PwXform3to2()

PWP_BOOL PwXform3to2 ( const PWGM_INDEX_XFORM pX3,
PWGM_INDEX_XFORM2 pX2 
)

Convert a 3D transform matrix to it's 2D equivalent.

Parameters
pX3Const pointer to a PWGM_INDEX_XFORM input buffer.
pX2Pointer to a PWGM_INDEX_XFORM2 output buffer.
The matrix mapping:
XFORM XFORM2
------- ------
A B C D A B D
E F G H ==> E F H
I J K L
Returns
PWP_TRUE on success.

Definition at line 648 of file apiGridModel.cxx.

References PWGM_INDEX_XFORM::m, PWGM_INDEX_XFORM2::m, PWP_FALSE, and PWP_TRUE.

Referenced by CaeStrGridModel::xform3to2().

◆ PwXformApply()

PWGM_INDEX3 PwXformApply ( const PWGM_INDEX_XFORM pX3,
PWGM_INDEX3  ijk 
)

Apply a PWGM_INDEX_XFORM transform to a PWGM_INDEX3 value.

Parameters
pX3Const pointer to the PWGM_INDEX_XFORM.
ijkThe PWGM_INDEX3 value to transform. It will not be changed.
Returns
The transformed PWGM_INDEX3 value.

Definition at line 671 of file apiGridModel.cxx.

References PWGM_INDEX3::i, PWGM_INDEX3::j, PWGM_INDEX3::k, and PWGM_INDEX_XFORM::m.

Referenced by CaeStrGridModel::xformApply().

◆ PwXformFollows()

PWGM_ENUM_IJK PwXformFollows ( const PWGM_INDEX_XFORM pX3,
PWGM_ENUM_IJK  localAxis,
PWP_BOOL pFlipped 
)

For a given localAxis, determine the corresponding axis in the transformed system.

Parameters
pX3Const pointer to the PWGM_INDEX_XFORM.
localAxisThe local axis of interest.
pFlippedFlag set to PWP_TRUE if the returned axis direction is the opposite of localAxis. Pointer may be NULL.
Returns
The corresponding axis in the transformed system.

Definition at line 685 of file apiGridModel.cxx.

References PWGM_INDEX3::i, PWGM_INDEX3::j, PWGM_INDEX3::k, PWGM_INDEX_XFORM::m, PWGM_IJK_I, PWGM_IJK_J, PWGM_IJK_K, PWP_FALSE, and PWP_TRUE.

Referenced by PwXform2Follows(), and CaeStrGridModel::xformFollows().