Pointwise Plugin SDK
Classes | Macros
PWGM-API Opaque Data Handle Types
+ Collaboration diagram for PWGM-API Opaque Data Handle Types:

Classes

struct  PWGM_HBLOCK
 An opaque handle to a grid block element. More...
 
struct  PWGM_HBLOCKASSEMBLER
 An opaque handle to an unstructured block assembler. More...
 
struct  PWGM_HBNDRY
 An opaque handle to a structured block boundary. More...
 
struct  PWGM_HCNXN
 An opaque handle to a structured, inter-block connection. More...
 
struct  PWGM_HCONNECTOR
 An opaque handle to a grid connector element. More...
 
struct  PWGM_HDOMAIN
 An opaque handle to a grid domain element. More...
 
struct  PWGM_HELEMENT
 Grid element handle declaration. More...
 
struct  PWGM_HELEMENT_BASE
 Only used as a generic base handle for PWGM_HELEMENT. More...
 
struct  PWGM_HGRIDMODEL
 An opaque handle to a grid model. More...
 
struct  PWGM_HVERTEX
 An opaque handle to a grid vertex element. More...
 
struct  PWGM_HVERTEXLIST
 Grid vertex list handle declaration. More...
 
struct  PWGM_HVERTEXLIST_BASE
 Only used as a generic base handle for PWGM_HVERTEXLIST. More...
 

Macros

#define PWGM_HBLOCK_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCK_ID(h)   PWP_HEGRP_ID(h)
 gets the block's guid from the handle More...
 
#define PWGM_HBLOCK_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HBLOCK_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCKASSEMBLER_H(h)   PWP_HEGRP_H(h)
 gets the assembler's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCKASSEMBLER_ID(h)   PWP_HEGRP_ID(h)
 gets the assembler's guid from the handle More...
 
#define PWGM_HBLOCKASSEMBLER_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HBLOCKASSEMBLER_MODEL(h)   PWP_HEGRP_H(h)
 gets the assembler's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBNDRY_H(h)   PWP_HEGRP_H(h)
 gets the boundary's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBNDRY_ID(h)   PWP_HEGRP_ID(h)
 gets the boundary's guid from the handle More...
 
#define PWGM_HBNDRY_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HBNDRY_MODEL(h)   PWP_HEGRP_H(h)
 gets the boundary's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCNXN_H(h)   PWP_HEGRP_H(h)
 gets the connection's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCNXN_ID(h)   PWP_HEGRP_ID(h)
 gets the connection's guid from the handle More...
 
#define PWGM_HCNXN_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HCNXN_MODEL(h)   PWP_HEGRP_H(h)
 gets the connection's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCONNECTOR_H(h)   PWP_HEGRP_H(h)
 gets the connector's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCONNECTOR_ID(h)   PWP_HEGRP_ID(h)
 gets the connector's guid from the handle More...
 
#define PWGM_HCONNECTOR_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HCONNECTOR_MODEL(h)   PWP_HEGRP_H(h)
 gets the connector's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HDOMAIN_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HDOMAIN_ID(h)   PWP_HEGRP_ID(h)
 gets the domain's guid from the handle More...
 
#define PWGM_HDOMAIN_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HDOMAIN_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_H(h)   PWP_HEGI_H(h)
 gets the element's PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_ID(h)   PWP_HEGI_ID(h)
 gets the element's guid from the handle More...
 
#define PWGM_HELEMENT_ISVALID(h)   PWP_HEGI_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HELEMENT_MODEL(h)   PWP_HEGI_H(h)
 gets the element's PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_PID(h)   PWP_HEGI_PID(h)
 gets the element's parent id More...
 
#define PWGM_HELEMENT_PTYPE(h)   PWP_HEGI_PTYPE(h)
 gets the element's parent handle type More...
 
#define PWGM_HGRIDMODEL_ISVALID(h)   PWP_HANDLE_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEX_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEX_ID(h)   PWP_HEGRP_ID(h)
 gets the vertex's guid from the handle More...
 
#define PWGM_HVERTEX_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEX_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_H(h)   PWP_HEGI_H(h)
 gets the embedded PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_ID(h)   PWP_HEGI_ID(h)
 gets the embedded guid from the handle More...
 
#define PWGM_HVERTEXLIST_ISVALID(h)   PWP_HEGI_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEXLIST_MODEL(h)   PWP_HEGI_H(h)
 gets the embedded PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_PID(h)   PWP_HEGI_PID(h)
 gets the embedded parent id More...
 
#define PWGM_HVERTEXLIST_PTYPE(h)   PWP_HEGI_PTYPE(h)
 gets the embedded parent handle type More...
 

Detailed Description

Opaque handles used to access export model data.

Cell-centric Unstructured Grid Hierarchy:
    PWGM_HGRIDMODEL
    |
    |---PWGM_HBLOCK[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   `---PWGM_HELEMENT[] 3D{tet, hex, wedge, pyramid} or 2D{tri, quad}
    |
    |---PWGM_HDOMAIN[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   `---PWGM_HELEMENT[] 3D{tri, quad} or 2D{bar}
    |
    `---PWGM_HVERTEX[]
\par "Face-centric Unstructured Grid Hierarchy:"
    PWGM_HGRIDMODEL
    |
    |---PWGM_HELEMENT[] 3D{tet, hex, wedge, pyramid} or 2D{tri, quad}
    |
    |---PWGM_FACESTREAM_DATA[] 3D{tri, quad} or 2D{bar}
    |
    `---PWGM_HVERTEX[]
\par "Structured Grid Hierarchy:"
    PWGM_HGRIDMODEL
    |
    |---PWGM_HBLOCK[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   |---PWGM_VERTDATA[]
    |   |
    |   |---PWGM_HCNXN[]
    |   |   |
    |   |   `---PWGM_CNXNDATA
    |   |
    |   `---PWGM_HBNDRY[]
    |       |
    |       |---PWGM_CONDDATA
    |       |
    |       `---PWGM_BNDRYDATA
    |
    |---PWGM_HCNXN[]
    |   |
    |   `---PWGM_CNXNDATA
    |
    `---PWGM_HBNDRY[]
        |
        |---PWGM_CONDDATA
        |
        `---PWGM_BNDRYDATA

Macro Definition Documentation

◆ PWGM_HBLOCK_H

#define PWGM_HBLOCK_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 365 of file apiGridModel.h.

Referenced by CaeBlock::moveNext(), and CaeBlock::movePrev().

◆ PWGM_HBLOCK_ID

#define PWGM_HBLOCK_ID (   h)    PWP_HEGRP_ID(h)

gets the block's guid from the handle

Definition at line 367 of file apiGridModel.h.

Referenced by CaeBlock::index(), CaeBlock::moveNext(), CaeBlock::movePrev(), operator<(), and operator==().

◆ PWGM_HBLOCK_ISVALID

#define PWGM_HBLOCK_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 349 of file apiGridModel.h.

Referenced by CaeBlock::isValid(), PwBlkCondition(), PwBlkElementCount(), and PwBlkEnumElements().

◆ PWGM_HBLOCK_MODEL

#define PWGM_HBLOCK_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 369 of file apiGridModel.h.

Referenced by CaeUnsBlock::model(), and CaeStrBlock::model().

◆ PWGM_HBLOCKASSEMBLER_H

#define PWGM_HBLOCKASSEMBLER_H (   h)    PWP_HEGRP_H(h)

gets the assembler's parent PWGM_HGRIDMODEL handle

Definition at line 583 of file apiGridModel.h.

◆ PWGM_HBLOCKASSEMBLER_ID

#define PWGM_HBLOCKASSEMBLER_ID (   h)    PWP_HEGRP_ID(h)

gets the assembler's guid from the handle

Definition at line 585 of file apiGridModel.h.

◆ PWGM_HBLOCKASSEMBLER_ISVALID

#define PWGM_HBLOCKASSEMBLER_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 569 of file apiGridModel.h.

◆ PWGM_HBLOCKASSEMBLER_MODEL

#define PWGM_HBLOCKASSEMBLER_MODEL (   h)    PWP_HEGRP_H(h)

gets the assembler's parent PWGM_HGRIDMODEL handle

Definition at line 587 of file apiGridModel.h.

◆ PWGM_HBNDRY_H

#define PWGM_HBNDRY_H (   h)    PWP_HEGRP_H(h)

gets the boundary's parent PWGM_HGRIDMODEL handle

Definition at line 474 of file apiGridModel.h.

◆ PWGM_HBNDRY_ID

#define PWGM_HBNDRY_ID (   h)    PWP_HEGRP_ID(h)

gets the boundary's guid from the handle

Definition at line 476 of file apiGridModel.h.

Referenced by CaeStrBoundary::data(), CaeStrBoundary::modelIndex(), operator<(), and operator==().

◆ PWGM_HBNDRY_ISVALID

#define PWGM_HBNDRY_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 460 of file apiGridModel.h.

Referenced by CaeStrBoundary::isValid().

◆ PWGM_HBNDRY_MODEL

#define PWGM_HBNDRY_MODEL (   h)    PWP_HEGRP_H(h)

gets the boundary's parent PWGM_HGRIDMODEL handle

Definition at line 478 of file apiGridModel.h.

Referenced by CaeStrBoundary::data(), and CaeStrBoundary::model().

◆ PWGM_HCNXN_H

#define PWGM_HCNXN_H (   h)    PWP_HEGRP_H(h)

gets the connection's parent PWGM_HGRIDMODEL handle

Definition at line 499 of file apiGridModel.h.

◆ PWGM_HCNXN_ID

#define PWGM_HCNXN_ID (   h)    PWP_HEGRP_ID(h)

gets the connection's guid from the handle

Definition at line 501 of file apiGridModel.h.

Referenced by CaeStrConnection::modelIndex(), operator<(), and operator==().

◆ PWGM_HCNXN_ISVALID

#define PWGM_HCNXN_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 485 of file apiGridModel.h.

Referenced by CaeStrConnection::isValid().

◆ PWGM_HCNXN_MODEL

#define PWGM_HCNXN_MODEL (   h)    PWP_HEGRP_H(h)

gets the connection's parent PWGM_HGRIDMODEL handle

Definition at line 503 of file apiGridModel.h.

Referenced by CaeStrConnection::model().

◆ PWGM_HCONNECTOR_H

#define PWGM_HCONNECTOR_H (   h)    PWP_HEGRP_H(h)

gets the connector's parent PWGM_HGRIDMODEL handle

Definition at line 524 of file apiGridModel.h.

◆ PWGM_HCONNECTOR_ID

#define PWGM_HCONNECTOR_ID (   h)    PWP_HEGRP_ID(h)

gets the connector's guid from the handle

Definition at line 526 of file apiGridModel.h.

◆ PWGM_HCONNECTOR_ISVALID

#define PWGM_HCONNECTOR_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 510 of file apiGridModel.h.

◆ PWGM_HCONNECTOR_MODEL

#define PWGM_HCONNECTOR_MODEL (   h)    PWP_HEGRP_H(h)

gets the connector's parent PWGM_HGRIDMODEL handle

Definition at line 528 of file apiGridModel.h.

◆ PWGM_HDOMAIN_H

#define PWGM_HDOMAIN_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 391 of file apiGridModel.h.

Referenced by CaeUnsPatch::model(), CaeUnsPatch::moveNext(), and CaeUnsPatch::movePrev().

◆ PWGM_HDOMAIN_ID

#define PWGM_HDOMAIN_ID (   h)    PWP_HEGRP_ID(h)

gets the domain's guid from the handle

Definition at line 393 of file apiGridModel.h.

Referenced by CaeUnsPatch::index().

◆ PWGM_HDOMAIN_ISVALID

#define PWGM_HDOMAIN_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 375 of file apiGridModel.h.

Referenced by CaeUnsPatch::isValid(), PwDomCondition(), PwDomElementCount(), and PwDomEnumElements().

◆ PWGM_HDOMAIN_MODEL

#define PWGM_HDOMAIN_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 395 of file apiGridModel.h.

◆ PWGM_HELEMENT_H

#define PWGM_HELEMENT_H (   h)    PWP_HEGI_H(h)

gets the element's PWGM_HGRIDMODEL handle

Definition at line 445 of file apiGridModel.h.

◆ PWGM_HELEMENT_ID

#define PWGM_HELEMENT_ID (   h)    PWP_HEGI_ID(h)

gets the element's guid from the handle

Definition at line 451 of file apiGridModel.h.

Referenced by CaeUnsElement::index(), operator<(), and operator==().

◆ PWGM_HELEMENT_ISVALID

#define PWGM_HELEMENT_ISVALID (   h)    PWP_HEGI_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 430 of file apiGridModel.h.

Referenced by CaeUnsElement::isValid(), CaePlugin< MT >::isValid(), PwElemDataMod(), and PwElemDataModEnum().

◆ PWGM_HELEMENT_MODEL

#define PWGM_HELEMENT_MODEL (   h)    PWP_HEGI_H(h)

gets the element's PWGM_HGRIDMODEL handle

Definition at line 453 of file apiGridModel.h.

Referenced by CaeUnsElement::model().

◆ PWGM_HELEMENT_PID

#define PWGM_HELEMENT_PID (   h)    PWP_HEGI_PID(h)

gets the element's parent id

Definition at line 447 of file apiGridModel.h.

Referenced by CaeUnsEnumElementData::blockId(), operator<(), and operator==().

◆ PWGM_HELEMENT_PTYPE

#define PWGM_HELEMENT_PTYPE (   h)    PWP_HEGI_PTYPE(h)

gets the element's parent handle type

Definition at line 449 of file apiGridModel.h.

Referenced by operator<(), and operator==().

◆ PWGM_HGRIDMODEL_ISVALID

#define PWGM_HGRIDMODEL_ISVALID (   h)    PWP_HANDLE_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 329 of file apiGridModel.h.

Referenced by PwGridRead().

◆ PWGM_HVERTEX_H

#define PWGM_HVERTEX_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 415 of file apiGridModel.h.

Referenced by CaeUnsVertex::model(), CaeUnsVertex::moveNext(), and CaeUnsVertex::movePrev().

◆ PWGM_HVERTEX_ID

#define PWGM_HVERTEX_ID (   h)    PWP_HEGRP_ID(h)

gets the vertex's guid from the handle

Definition at line 417 of file apiGridModel.h.

Referenced by CaeUnsVertex::index(), operator<(), and operator==().

◆ PWGM_HVERTEX_ISVALID

#define PWGM_HVERTEX_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 401 of file apiGridModel.h.

Referenced by CaeUnsVertex::isValid(), PwVertDataMod(), PwVertIndexMod(), and PwVertXyzVal().

◆ PWGM_HVERTEX_MODEL

#define PWGM_HVERTEX_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 419 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_H

#define PWGM_HVERTEXLIST_H (   h)    PWP_HEGI_H(h)

gets the embedded PWGM_HGRIDMODEL handle

Definition at line 554 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_ID

#define PWGM_HVERTEXLIST_ID (   h)    PWP_HEGI_ID(h)

gets the embedded guid from the handle

Definition at line 560 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_ISVALID

#define PWGM_HVERTEXLIST_ISVALID (   h)    PWP_HEGI_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 539 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_MODEL

#define PWGM_HVERTEXLIST_MODEL (   h)    PWP_HEGI_H(h)

gets the embedded PWGM_HGRIDMODEL handle

Definition at line 562 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_PID

#define PWGM_HVERTEXLIST_PID (   h)    PWP_HEGI_PID(h)

gets the embedded parent id

Definition at line 556 of file apiGridModel.h.

◆ PWGM_HVERTEXLIST_PTYPE

#define PWGM_HVERTEXLIST_PTYPE (   h)    PWP_HEGI_PTYPE(h)

gets the embedded parent handle type

Definition at line 558 of file apiGridModel.h.