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

Modules

 Structured Grid Export Utility Functions
 

Functions

PWP_UINT32 PwBlkBoundaryCount (PWGM_HBLOCK block)
 Get the number of boundaries in the block. More...
 
PWP_UINT32 PwBlkConnectionCount (PWGM_HBLOCK block)
 Get the number of connections in the block. More...
 
PWGM_HBNDRY PwBlkEnumBoundaries (PWGM_HBLOCK block, PWP_UINT32 ndx)
 Sequentially enumerate the block's boundaries. More...
 
PWGM_HCNXN PwBlkEnumConnections (PWGM_HBLOCK block, PWP_UINT32 ndx)
 Sequentially enumerate the block's connections. More...
 
PWP_BOOL PwBlkNdxBoundary (PWGM_HBLOCK block, PWP_UINT32 ndx, PWGM_BNDRYDATA *pBndryData)
 Get the data for the block's nth structured boundary. More...
 
PWP_BOOL PwBlkNdxBoundaryAndCondition (PWGM_HBLOCK block, PWP_UINT32 ndx, PWGM_BNDRYDATA *pBndryData, PWGM_CONDDATA *pCondData)
 Get the PWGM_BNDRYDATA and PWGM_CONDDATA for the block's nth structured boundary. More...
 
PWP_BOOL PwBlkNdxConnection (PWGM_HBLOCK block, PWP_UINT32 ndx, PWGM_CNXNDATA *pCnxnData)
 Get the data for the block's nth connection. More...
 
PWP_BOOL PwBlkNdxVertData (PWGM_HBLOCK block, PWGM_INDEX3 ndx3, PWGM_VERTDATA *pVertData)
 Get the block's vertex data at the given index location. More...
 
PWP_BOOL PwBlkSize (PWGM_HBLOCK block, PWGM_STR_SIZE *pSize)
 Get the block's vertex-size. More...
 
PWP_BOOL PwBndryCondition (PWGM_HBNDRY boundary, PWGM_CONDDATA *pCondData)
 Get the boundary's condition data. More...
 
PWP_BOOL PwBoundary (PWGM_HBNDRY boundary, PWGM_BNDRYDATA *pBndryData)
 Get the boundary data. More...
 
PWP_BOOL PwConnection (PWGM_HCNXN connection, PWGM_CNXNDATA *pCnxnData)
 Get the connection data. More...
 
PWP_UINT32 PwModBoundaryCount (PWGM_HGRIDMODEL model)
 Get the number of structured grid boundaries in the model. More...
 
PWP_UINT32 PwModConnectionCount (PWGM_HGRIDMODEL model)
 Get the number of structured grid connections in the model. More...
 
PWP_BOOL PwModCustomIndex3SchemeReady (PWGM_HGRIDMODEL model, PWGM_INDEX3MAPPERCB cb, void *cbData)
 Notifys the Pointwise export framework that the custom index3 map is ready. More...
 
PWGM_HBNDRY PwModEnumBoundaries (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
 Sequentially enumerate the model's boundaries. More...
 
PWGM_HCNXN PwModEnumConnections (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
 Sequentially enumerate the model's connections. More...
 
PWP_BOOL PwModNdxBoundary (PWGM_HGRIDMODEL model, PWP_UINT32 ndx, PWGM_BNDRYDATA *pBndryData)
 Get the data for the model's nth structured boundary. More...
 
PWP_BOOL PwModNdxBoundaryAndCondition (PWGM_HGRIDMODEL model, PWP_UINT32 ndx, PWGM_BNDRYDATA *pBndryData, PWGM_CONDDATA *pCondData)
 Get the PWGM_BNDRYDATA and PWGM_CONDDATA for the model's nth structured boundary. More...
 
PWP_BOOL PwModNdxConnection (PWGM_HGRIDMODEL model, PWP_UINT32 ndx, PWGM_CNXNDATA *pCnxnData)
 Get the data for the model's nth connection. More...
 

Detailed Description

These functions are ONLY used to access structured grid models.

Function Documentation

◆ PwBlkBoundaryCount()

PWP_UINT32 PwBlkBoundaryCount ( PWGM_HBLOCK  block)

Get the number of boundaries in the block.

Parameters
blockA block handle.

Definition at line 535 of file apiGridModel.cxx.

◆ PwBlkConnectionCount()

PWP_UINT32 PwBlkConnectionCount ( PWGM_HBLOCK  block)

Get the number of connections in the block.

Parameters
blockA block handle.

Definition at line 551 of file apiGridModel.cxx.

◆ PwBlkEnumBoundaries()

PWGM_HBNDRY PwBlkEnumBoundaries ( PWGM_HBLOCK  block,
PWP_UINT32  ndx 
)

Sequentially enumerate the block's boundaries.

Parameters
blockA block handle.
ndxThe boundary index starting at 0.
Returns
valid boundary handle on success.
Sample usage:
PWP_UINT32 bndryCnt = PwBlkBoundaryCount(block);
PWP_UINT32 ndx = 0;
PWGM_HBNDRY boundary = PwBlkEnumBoundaries(block, ndx);
while (PWGM_HBNDRY_ISVALID(boundary)) {
// ...etc...
boundary = PwBlkEnumBoundaries(block, ++ndx);
}

Definition at line 543 of file apiGridModel.cxx.

◆ PwBlkEnumConnections()

PWGM_HCNXN PwBlkEnumConnections ( PWGM_HBLOCK  block,
PWP_UINT32  ndx 
)

Sequentially enumerate the block's connections.

Parameters
blockA block handle.
ndxThe connection index starting at 0.
Returns
valid connection handle on success.
Sample usage:
PWP_UINT32 ndx = 0;
PWGM_HCNXN connection = PwBlkEnumConnections(block, ndx);
while (PWGM_HCNXN_ISVALID(connection)) {
// ...etc...
connection = PwBlkEnumBoundaries(block, ++ndx);
}

Definition at line 559 of file apiGridModel.cxx.

◆ PwBlkNdxBoundary()

PWP_BOOL PwBlkNdxBoundary ( PWGM_HBLOCK  block,
PWP_UINT32  ndx,
PWGM_BNDRYDATA pBndryData 
)

Get the data for the block's nth structured boundary.

Parameters
blockA block handle.
ndxThe block's boundary index starting at 0.
pBndryDataPointer to a PWGM_BNDRYDATA buffer.
Equivalent to:
PwBoundary(PwBlkEnumBoundaries(block, ndx), &bndryData);
Returns
PWP_TRUE on success.

Definition at line 567 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwBlkNdxBoundaryAndCondition()

PWP_BOOL PwBlkNdxBoundaryAndCondition ( PWGM_HBLOCK  block,
PWP_UINT32  ndx,
PWGM_BNDRYDATA pBndryData,
PWGM_CONDDATA pCondData 
)

Get the PWGM_BNDRYDATA and PWGM_CONDDATA for the block's nth structured boundary.

Parameters
blockA block handle.
ndxThe block's boundary index starting at 0.
pBndryDataPointer to a PWGM_BNDRYDATA buffer or NULL.
pCondDataPointer to a PWGM_CONDDATA buffer or NULL.
Equivalent to:
hBndry = PwBlkEnumBoundaries(block, ndx);
PwBoundary(hBndry, &bndryData) && PwBndryCondition(hBndry, &condData);
Note
It is an error if both pBndryData and pCondData are NULL.
Returns
PWP_TRUE on success.

Definition at line 575 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwBlkNdxConnection()

PWP_BOOL PwBlkNdxConnection ( PWGM_HBLOCK  block,
PWP_UINT32  ndx,
PWGM_CNXNDATA pCnxnData 
)

Get the data for the block's nth connection.

Parameters
blockA block handle.
ndxThe block's connection index starting at 0.
pCnxnDataPointer to a PWGM_CNXNDATA buffer.
Equivalent to:
PwConnection(PwBlkEnumConnections(block, ndx), &cnxnData);
Returns
PWP_TRUE on success.

Definition at line 586 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwBlkNdxVertData()

PWP_BOOL PwBlkNdxVertData ( PWGM_HBLOCK  block,
PWGM_INDEX3  ndx3,
PWGM_VERTDATA pVertData 
)

Get the block's vertex data at the given index location.

Parameters
blockA block handle.
ndx3The ijk block location.
pVertDataPointer to a PWGM_VERTDATA buffer.
Returns
PWP_FALSE if block is not structured or ndx3 is invalid

Definition at line 518 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrBlock::ndxVertData().

◆ PwBlkSize()

PWP_BOOL PwBlkSize ( PWGM_HBLOCK  block,
PWGM_STR_SIZE pSize 
)

Get the block's vertex-size.

Parameters
blockA block handle.
pSizePointer to a PWGM_STR_SIZE buffer.
Returns
PWP_FALSE if block is not structured

Definition at line 510 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrBlock::size().

◆ PwBndryCondition()

PWP_BOOL PwBndryCondition ( PWGM_HBNDRY  boundary,
PWGM_CONDDATA pCondData 
)

Get the boundary's condition data.

Parameters
boundaryA boundary handle.
pCondDataPointer to a PWGM_CONDDATA buffer.
Returns
PWP_TRUE on success.

Definition at line 602 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrBoundary::data().

◆ PwBoundary()

PWP_BOOL PwBoundary ( PWGM_HBNDRY  boundary,
PWGM_BNDRYDATA pBndryData 
)

Get the boundary data.

Parameters
boundaryA boundary handle.
pBndryDataPointer to a PWGM_BNDRYDATA buffer.
Returns
PWP_TRUE on success.

Definition at line 594 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrBoundary::data().

◆ PwConnection()

PWP_BOOL PwConnection ( PWGM_HCNXN  connection,
PWGM_CNXNDATA pCnxnData 
)

Get the connection data.

Parameters
connectionA connection handle.
pCnxnDataPointer to a PWGM_CNXNDATA buffer.
Returns
PWP_TRUE on success.

Definition at line 610 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrConnection::data().

◆ PwModBoundaryCount()

PWP_UINT32 PwModBoundaryCount ( PWGM_HGRIDMODEL  model)

Get the number of structured grid boundaries in the model.

Parameters
modelThe grid model handle.

Definition at line 448 of file apiGridModel.cxx.

◆ PwModConnectionCount()

PWP_UINT32 PwModConnectionCount ( PWGM_HGRIDMODEL  model)

Get the number of structured grid connections in the model.

Parameters
modelThe grid model handle.

Definition at line 464 of file apiGridModel.cxx.

◆ PwModCustomIndex3SchemeReady()

PWP_BOOL PwModCustomIndex3SchemeReady ( PWGM_HGRIDMODEL  model,
PWGM_INDEX3MAPPERCB  cb,
void *  cbData 
)

Notifys the Pointwise export framework that the custom index3 map is ready.

Parameters
modelThe grid model handle.

This is only needed if IndexScheme is set to Custom in runtimeCreate(). After the mesh data has been succesfully exported, but before returning from runtimeWrite(), the plugin must call PwModCustomIndex3SchemeReady() to notify the Pointwise export framework that the custom index map is ready.

While in this call, the Pointwise export framework invokes the PWGM_INDEX3MAPPERCB callback as needed to map vertex indices.

The vertax map is no longer needed by the Pointwise export framework after this call returns.

Returns
PWP_TRUE on success

Definition at line 526 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrGridModel::customIndexSchemeReady().

◆ PwModEnumBoundaries()

PWGM_HBNDRY PwModEnumBoundaries ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx 
)

Sequentially enumerate the model's boundaries.

Parameters
modelThe grid model handle.
ndxThe boundary index starting at 0.
Returns
valid boundary handle on success.
Sample usage:
PWP_UINT32 bndryCnt = PwModBoundaryCount(model);
PWP_UINT32 ndx = 0;
PWGM_HBNDRY boundary = PwModEnumBoundaries(model, ndx);
while (PWGM_HBNDRY_ISVALID(boundary)) {
// ...etc...
boundary = PwModEnumBoundaries(model, ++ndx);
}

Definition at line 456 of file apiGridModel.cxx.

◆ PwModEnumConnections()

PWGM_HCNXN PwModEnumConnections ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx 
)

Sequentially enumerate the model's connections.

Parameters
modelThe grid model handle.
ndxThe connection index starting at 0.
Returns
valid connection handle on success.
Sample usage:
PWP_UINT32 ndx = 0;
PWGM_HCNXN connection = PwModEnumConnections(model, ndx);
while (PWGM_HCNXN_ISVALID(connection)) {
// ...etc...
connection = PwModEnumConnections(model, ++ndx);
}

Definition at line 472 of file apiGridModel.cxx.

◆ PwModNdxBoundary()

PWP_BOOL PwModNdxBoundary ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx,
PWGM_BNDRYDATA pBndryData 
)

Get the data for the model's nth structured boundary.

Parameters
modelThe grid model handle.
ndxThe model's boundary index starting at 0.
pBndryDataPointer to a PWGM_BNDRYDATA buffer.
Equivalent to:
PwBoundary(PwModEnumBoundaries(model, ndx), &bndryData);
Returns
PWP_TRUE on success.

Definition at line 480 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwModNdxBoundaryAndCondition()

PWP_BOOL PwModNdxBoundaryAndCondition ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx,
PWGM_BNDRYDATA pBndryData,
PWGM_CONDDATA pCondData 
)

Get the PWGM_BNDRYDATA and PWGM_CONDDATA for the model's nth structured boundary.

Parameters
modelThe grid model handle.
ndxThe model's boundary index starting at 0.
pBndryDataPointer to a PWGM_BNDRYDATA buffer or NULL.
pCondDataPointer to a PWGM_CONDDATA buffer or NULL.
Equivalent to:
hBndry = PwModEnumBoundaries(model, ndx);
PwBoundary(hBndry, &bndryData) && PwBndryCondition(hBndry, &condData);
Note
It is an error if both pBndryData and pCondData are NULL.
Returns
PWP_TRUE on success.

Definition at line 490 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by CaeStrBoundary::data().

◆ PwModNdxConnection()

PWP_BOOL PwModNdxConnection ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx,
PWGM_CNXNDATA pCnxnData 
)

Get the data for the model's nth connection.

Parameters
modelThe grid model handle.
ndxThe model's connection index starting at 0.
pCnxnDataPointer to a PWGM_CNXNDATA buffer.
Equivalent to:
PwConnection(PwModEnumConnections(model, ndx), &cnxnData);
Returns
PWP_TRUE on success.

Definition at line 501 of file apiGridModel.cxx.

References PWP_FALSE.