apiGridModel.h File Reference

Pointwise Grid Model API Specification (PWGM-API) More...

#include <stdio.h>
#include "apiPWP.h"

Include dependency graph for apiGridModel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PWGM_ASSEMBLER_DATA
	Face descriptor data type. Used for face assembler functions. More...
struct	PWGM_BEGINSTREAM_DATA
	Data passed to a PWGM_BEGINSTREAMCB callback function. More...
struct	PWGM_BLOCKDATA
	Block data type. More...
struct	PWGM_BNDRYDATA
	Structured grid boundary data type. More...
struct	PWGM_CNXNDATA
	Structured grid, inter-block, connection data type. More...
struct	PWGM_CONDDATA
	Condition descriptor data type. More...
struct	PWGM_ELEMCOUNTS
	Element count information. More...
struct	PWGM_ELEMDATA
	Element descriptor data type. More...
struct	PWGM_ENDSTREAM_DATA
	Data passed to a PWGM_ENDSTREAMCB callback function. More...
struct	PWGM_ENUMELEMDATA
	Enumerated model element descriptor data type. More...
struct	PWGM_FACEREF_DATA
	Information about a block cell element that touches a face. More...
struct	PWGM_FACESTREAM_DATA
	Data passed to a PWGM_FACESTREAMCB callback function. More...
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...
struct	PWGM_INDEX2
	Structured grid ijk index data type. More...
struct	PWGM_INDEX3
	Structured grid ijk index data type. More...
struct	PWGM_INDEX_XFORM
	The 3D transform matrix data type. More...
struct	PWGM_INDEX_XFORM2
	The 2D transform matrix data type. More...
struct	PWGM_STR_RANGE
	Structured grid ijk range data type. More...
struct	PWGM_VERTDATA
	Vertex descriptor data type. More...

Macros
#define	PWGM_CONDKEY_UNDEF   PWP_UINT32_UNDEF
	The "undefined" condition key value. More...
#define	PWGM_ECNT_Bar(ecs)   (ecs).count[PWGM_ELEMTYPE_BAR]
	Extract the Bar count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Hex(ecs)   (ecs).count[PWGM_ELEMTYPE_HEX]
	Extract the Hex count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Point(ecs)   (ecs).count[PWGM_ELEMTYPE_POINT]
	Extract the Point count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Pyramid(ecs)   (ecs).count[PWGM_ELEMTYPE_PYRAMID]
	Extract the Pyramid count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Quad(ecs)   (ecs).count[PWGM_ELEMTYPE_QUAD]
	Extract the Quad count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Tet(ecs)   (ecs).count[PWGM_ELEMTYPE_TET]
	Extract the Tet count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Tri(ecs)   (ecs).count[PWGM_ELEMTYPE_TRI]
	Extract the Tri count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ECNT_Wedge(ecs)   (ecs).count[PWGM_ELEMTYPE_WEDGE]
	Extract the Wedge count from a PWGM_ELEMCOUNTS struct. More...
#define	PWGM_ELEMDATA_VERT_SIZE   8
	Maximum number of verts allowed per element. More...
#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...
#define	PWGM_UNSPECIFIED_COND_ID   PWP_UINT32(2147483647)
	The id of the global, Unspecified condition descriptor. More...
#define	PWGM_UNSPECIFIED_TYPE_ID   PWP_UINT32(0)
	The Unspecified physical type id. More...

Typedefs
typedef PWP_UINT32(*	PWGM_BEGINSTREAMCB) (PWGM_BEGINSTREAM_DATA *data)
	The begin stream callback function signature. More...
typedef PWP_UINT32	PWGM_CONDKEY
	The condition key integral type. More...
typedef PWP_UINT32(*	PWGM_ENDSTREAMCB) (PWGM_ENDSTREAM_DATA *data)
	The face stream callback function signature. More...
typedef PWP_UINT32(*	PWGM_FACESTREAMCB) (PWGM_FACESTREAM_DATA *data)
	The face stream callback function signature. More...
typedef PWGM_INDEX3(*	PWGM_INDEX3MAPPERCB) (const PWGM_INDEX3 pwgmNdx, void *data)
	The custom, structured Index3Scheme mapper callback function signature. More...
typedef PWP_UINT64(*	PWGM_INDEXMAPPERCB) (const PWP_UINT64 pwgmNdx, void *data)
	The custom, unstructured IndexScheme mapper callback function signature. More...
typedef PWGM_INDEX3 PW_DLL_IMPEXP	PWGM_STR_SIZE
	Structured grid ijk size data type. More...
typedef PWP_REAL	PWGM_XYZVAL
	XYZ component data type. More...

Enumerations
enum	PWGM_CNXNTYPE {   PWGM_CNXNTYPE_ONE_TO_ONE,   PWGM_CNXNTYPE_MANY_TO_ONE,   PWGM_CNXNTYPE_MANY_TO_MANY,   PWGM_CNXNTYPE_NONE }
	Structured grid block-point association. More...
enum	PWGM_ENUM_ELEMORDER {   PWGM_ELEMORDER_HEX = PWGM_ELEMTYPE_HEX,   PWGM_ELEMORDER_QUAD = PWGM_ELEMTYPE_QUAD,   PWGM_ELEMORDER_TRI = PWGM_ELEMTYPE_TRI,   PWGM_ELEMORDER_TET = PWGM_ELEMTYPE_TET,   PWGM_ELEMORDER_WEDGE = PWGM_ELEMTYPE_WEDGE,   PWGM_ELEMORDER_PYRAMID = PWGM_ELEMTYPE_PYRAMID,   PWGM_ELEMORDER_VC }
	Types of element orderings. More...
enum	PWGM_ENUM_ELEMTYPE {   PWGM_ELEMTYPE_BAR,   PWGM_ELEMTYPE_HEX,   PWGM_ELEMTYPE_QUAD,   PWGM_ELEMTYPE_TRI,   PWGM_ELEMTYPE_TET,   PWGM_ELEMTYPE_WEDGE,   PWGM_ELEMTYPE_PYRAMID,   PWGM_ELEMTYPE_POINT }
	Element type ids. More...
enum	PWGM_ENUM_FACEORDER {   PWGM_FACEORDER_DONTCARE,   PWGM_FACEORDER_BOUNDARYFIRST,   PWGM_FACEORDER_INTERIORFIRST,   PWGM_FACEORDER_BOUNDARYONLY,   PWGM_FACEORDER_INTERIORONLY,   PWGM_FACEORDER_BCGROUPSFIRST,   PWGM_FACEORDER_BCGROUPSLAST,   PWGM_FACEORDER_BCGROUPSONLY,   PWGM_FACEORDER_VCGROUPSBCLAST,   PWGM_FACEORDER_BCGROUPSONLY_BYVC }
	The orderings supported by face streaming. More...
enum	PWGM_ENUM_FACETYPE {   PWGM_FACETYPE_BOUNDARY,   PWGM_FACETYPE_INTERIOR,   PWGM_FACETYPE_CONNECTION }
	The facetypes supported by face streaming. More...
enum	PWGM_ENUM_GRIDTYPE {   PWGM_GRIDTYPE_STRUCTURED,   PWGM_GRIDTYPE_UNSTRUCTURED }
enum	PWGM_ENUM_IJK {   PWGM_IJK_I,   PWGM_IJK_J,   PWGM_IJK_K }
	IJK component type ids. More...
enum	PWGM_ENUM_XYZ {   PWGM_XYZ_X,   PWGM_XYZ_Y,   PWGM_XYZ_Z }
	XYZ component type ids. More...
enum	PWGM_FACE_ID {   PWGM_FACE_KMIN,   PWGM_FACE_KMAX,   PWGM_FACE_IMIN,   PWGM_FACE_IMAX,   PWGM_FACE_JMIN,   PWGM_FACE_JMAX,   PWGM_FACE_UNSTR }
	Structured grid block-face ids. More...

Functions
PWP_BOOL	PwAsmFinalize (PWGM_HBLOCKASSEMBLER h)
	Stitches together all the faces added to the assembler into cells and blocks. More...
PWGM_HVERTEXLIST	PwAsmGetVertexList (PWGM_HBLOCKASSEMBLER h)
	Get the vertex list associated with an unstructured block assembler. More...
PWP_BOOL	PwAsmPushElementFace (PWGM_HBLOCKASSEMBLER h, const PWGM_ASSEMBLER_DATA *face)
	Adds a face to an unstructured block face assembler. More...
PWP_BOOL	PwAsmSetCellConditionKey (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const PWP_UINT32 cell)
	Tags a single cells with the condition identified by key. More...
PWP_BOOL	PwAsmSetCellSpanConditionKey (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const PWP_UINT32 startCell, const PWP_UINT32 endCell)
	Tags a contiguous span of cells with the condition identified by key. More...
PWP_BOOL	PwAsmSetCondition (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const PWGM_CONDDATA &condData)
	Sets the condition data of the condition identified by key. More...
PWP_BOOL	PwAsmSetConditionTypeId (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const PWP_UINT32 typeId)
	Sets the type id of the condition identified by key. More...
PWP_BOOL	PwAsmSetConditionTypeName (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const char *typeName)
	Sets the type name of the condition identified by key. More...
PWP_BOOL	PwAsmSetConditionUserId (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const PWP_UINT32 userId)
	Sets the user id of the condition identified by key. More...
PWP_BOOL	PwAsmSetConditionUserName (PWGM_HBLOCKASSEMBLER assembler, const PWGM_CONDKEY key, const char *userName)
	Sets the user name of the condition identified by key. More...
PWP_BOOL	PwAsmSetProperty (PWGM_HBLOCKASSEMBLER assembler, const PWP_UINT32 propertySetId, const char *key, const char *val)
	Sets the text value of a property identified by key. More...
PWP_UINT32	PwBlkBoundaryCount (PWGM_HBLOCK block)
	Get the number of boundaries in the block. More...
PWP_BOOL	PwBlkCondition (PWGM_HBLOCK block, PWGM_CONDDATA *pCondData)
	Get the block condition data. More...
PWP_UINT32	PwBlkConnectionCount (PWGM_HBLOCK block)
	Get the number of connections in the block. More...
PWP_UINT32	PwBlkElementCount (PWGM_HBLOCK block, PWGM_ELEMCOUNTS *pCounts)
	Get the number of block elements. 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...
PWGM_HELEMENT	PwBlkEnumElements (PWGM_HBLOCK block, PWP_UINT32 ndx)
	Sequentially enumerate the block elements. More...
PWGM_HVERTEXLIST	PwBlkGetVertexList (PWGM_HBLOCK h)
	Get the vertex list associated with an unstructured or structured block. 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	PwBlkSetCondition (PWGM_HBLOCK block, const PWGM_CONDDATA &condData)
	Sets the condition data for a grid entity. More...
PWP_BOOL	PwBlkSetConditionTypeId (PWGM_HBLOCK block, const PWP_UINT32 typeId)
	Sets the condition data for a grid entity. More...
PWP_BOOL	PwBlkSetConditionTypeName (PWGM_HBLOCK block, const char *typeName)
	Sets the condition data for a grid entity. More...
PWP_BOOL	PwBlkSetConditionUserId (PWGM_HBLOCK block, const PWP_UINT32 userId)
	Sets the condition data for a grid entity. More...
PWP_BOOL	PwBlkSetConditionUserName (PWGM_HBLOCK block, const char *userName)
	Sets the condition name for a grid entity. More...
PWP_BOOL	PwBlkSetExportName (PWGM_HBLOCK block, const char *name)
	Set the name used to identify the block or group of blocks in the exported grid. More...
PWP_BOOL	PwBlkSetName (PWGM_HBLOCK h, const char *name)
	Set a block's name. More...
PWP_BOOL	PwBlkSetProperty (PWGM_HBLOCK block, const char *key, const char *val)
	Sets the text value of a property identified by key. More...
PWP_BOOL	PwBlkSize (PWGM_HBLOCK block, PWGM_STR_SIZE *pSize)
	Get the block's vertex-size. More...
PWP_BOOL	PwBlock (PWGM_HBLOCK block, PWGM_BLOCKDATA *pBlockData)
	Get the block data. 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...
PWGM_HVERTEXLIST	PwConGetVertexList (PWGM_HCONNECTOR h)
	Get the vertex list associated with a connector. More...
PWP_BOOL	PwConnection (PWGM_HCNXN connection, PWGM_CNXNDATA *pCnxnData)
	Get the connection data. More...
PWP_BOOL	PwConSetCondition (PWGM_HCONNECTOR connector, const PWGM_CONDDATA &condData)
	Sets the condition data for a connector. More...
PWP_BOOL	PwConSetConditionTypeId (PWGM_HCONNECTOR connector, const PWP_UINT32 typeId)
	Sets the condition data for a connector. More...
PWP_BOOL	PwConSetConditionTypeName (PWGM_HCONNECTOR connector, const char *typeName)
	Sets the condition data for a connector. More...
PWP_BOOL	PwConSetConditionUserId (PWGM_HCONNECTOR connector, const PWP_UINT32 userId)
	Sets the condition data for a connector. More...
PWP_BOOL	PwConSetConditionUserName (PWGM_HCONNECTOR connector, const char *userName)
	Sets the condition name for a connector. More...
PWP_BOOL	PwConSetName (PWGM_HCONNECTOR h, const char *name)
	Set a connector's name. More...
PWP_BOOL	PwConSetProperty (PWGM_HCONNECTOR connector, const char *key, const char *val)
	Sets the text value of a property identified by key. More...
PWP_BOOL	PwDomCondition (PWGM_HDOMAIN domain, PWGM_CONDDATA *pCondData)
	Get the domain condition data. More...
PWP_UINT32	PwDomElementCount (PWGM_HDOMAIN domain, PWGM_ELEMCOUNTS *pCounts)
	Get the number of domain elements. More...
PWGM_HELEMENT	PwDomEnumElements (PWGM_HDOMAIN domain, PWP_UINT32 ndx)
	Sequentially enumerate the domain elements. More...
PWGM_HVERTEXLIST	PwDomGetVertexList (PWGM_HDOMAIN h)
	Get the vertex list associated with an unstructured or structured domain. More...
PWP_BOOL	PwDomSetCondition (PWGM_HDOMAIN domain, const PWGM_CONDDATA &condData)
	Sets the condition data for a domain. More...
PWP_BOOL	PwDomSetConditionTypeId (PWGM_HDOMAIN domain, const PWP_UINT32 typeId)
	Sets the condition data for a domain. More...
PWP_BOOL	PwDomSetConditionTypeName (PWGM_HDOMAIN domain, const char *typeName)
	Sets the condition data for a domain. More...
PWP_BOOL	PwDomSetConditionUserId (PWGM_HDOMAIN domain, const PWP_UINT32 userId)
	Sets the condition data for a domain. More...
PWP_BOOL	PwDomSetConditionUserName (PWGM_HDOMAIN domain, const char *userName)
	Sets the condition name for a domain. More...
PWP_BOOL	PwDomSetName (PWGM_HDOMAIN h, const char *name)
	Set a domain's name. More...
PWP_BOOL	PwDomSetProperty (PWGM_HDOMAIN domain, const char *key, const char *val)
	Sets the text value of a property identified by key. More...
PWP_BOOL	PwElemDataMod (PWGM_HELEMENT element, PWGM_ELEMDATA *pElemData)
	Get the element data relative to the model's index space. More...
PWP_BOOL	PwElemDataModEnum (PWGM_HELEMENT element, PWGM_ENUMELEMDATA *pElemData)
	Get the enumerated element data relative to the model's index space. More...
const char *	PwElemTypeToText (PWGM_ENUM_ELEMTYPE type)
	Maps a PWGM_ENUM_ELEMTYPE value to a human readable string. More...
const char *	PwFaceOrderToText (PWGM_ENUM_FACEORDER faceOrder)
	Maps a PWGM_ENUM_FACEORDER value to a human readable string. More...
PWP_BOOL	PwInRange (PWGM_INDEX3 ijk, const PWGM_STR_RANGE *pRange)
	Determines if an PWGM_INDEX3 is within a PWGM_STR_RANGE. More...
PWP_BOOL	PwModAppendEnumElementOrder (PWGM_HGRIDMODEL model, PWGM_ENUM_ELEMORDER order)
	Append an element order to the enumElements() ordering sequence. More...
PWP_UINT32	PwModBlockCount (PWGM_HGRIDMODEL model)
	Get the number of block elements in the model. 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...
PWGM_HCONNECTOR	PwModCreateCon (PWGM_HGRIDMODEL model, PWP_UINT size)
	Creates a connector in a model. More...
PWGM_HBLOCK	PwModCreateStrBlock (PWGM_HGRIDMODEL model, const PWGM_STR_SIZE blkSize)
	Creates a structured block in a model. More...
PWGM_HDOMAIN	PwModCreateStrDomain (PWGM_HGRIDMODEL model, const PWGM_STR_SIZE domSize)
	Creates a structured domain in a model. More...
PWGM_HVERTEXLIST	PwModCreateUnsVertexList (PWGM_HGRIDMODEL model, const PWP_ENUM_DIMENSION blkElemDimty)
	Creates an empty, unstructured vertex list in a model. More...
PWGM_HVERTEXLIST	PwModCreateUnsVertexList2 (PWGM_HGRIDMODEL model)
	Creates an empty, unstructured vertex list in a model for 2-D blocks and 1-D domains. More...
PWGM_HVERTEXLIST	PwModCreateUnsVertexList3 (PWGM_HGRIDMODEL model)
	Creates an empty, unstructured vertex list in a model for 3-D blocks and 2-D domains. More...
PWP_BOOL	PwModCustomIndex3SchemeReady (PWGM_HGRIDMODEL model, PWGM_INDEX3MAPPERCB cb, void *cbData)
	Notifys the Pointwise export framework that the custom, structured index3 map is ready. More...
PWP_BOOL	PwModCustomIndexSchemeReady (PWGM_HGRIDMODEL model, PWGM_INDEXMAPPERCB cb, void *cbData)
	Notifys the Pointwise export framework that the custom, unstructured index map is ready. More...
PWP_VOID	PwModDefaultEnumElementOrder (PWGM_HGRIDMODEL model)
	Reset the enumElements() ordering sequence to the default (none). More...
PWP_UINT32	PwModDomainCount (PWGM_HGRIDMODEL model)
	Get the number of domain elements in the model. More...
PWGM_HBLOCK	PwModEnumBlocks (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
	Sequentially enumerate the model block elements. 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...
PWGM_HDOMAIN	PwModEnumDomains (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
	Sequentially enumerate the model domain elements. More...
PWP_UINT32	PwModEnumElementCount (PWGM_HGRIDMODEL model, PWGM_ELEMCOUNTS *pCounts)
	Get the number of enumerated model block elements. More...
PWGM_HELEMENT	PwModEnumElements (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
	Sequentially enumerate the model's block elements. More...
PWGM_HVERTEX	PwModEnumVertices (PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
	Sequentially enumerate the model vertex elements. More...
PWP_BOOL	PwModGetAttributeValue (PWGM_HGRIDMODEL model, const char *name, PWP_ENUM_VALTYPE bufType, void *buf, PWP_UINT count)
	Get an attribute's value. 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...
PWP_BOOL	PwModStreamFaces (PWGM_HGRIDMODEL model, PWGM_ENUM_FACEORDER order, PWGM_BEGINSTREAMCB beginCB, PWGM_FACESTREAMCB faceCB, PWGM_ENDSTREAMCB endCB, void *userData)
	Stream the grid model's faces to a callback function in the specified order. More...
PWP_UINT32	PwModVertexCount (PWGM_HGRIDMODEL model)
	Get the number of model vertex elements. More...
PWP_BOOL	PwUnsBlkAllocateElementCounts (PWGM_HBLOCK h, const PWGM_ELEMCOUNTS &counts)
	Allocates element storage in an unstructured block. More...
PWP_BOOL	PwUnsBlkAllocateElements (PWGM_HBLOCK h, const PWGM_ENUM_ELEMTYPE cellType, const PWP_UINT count)
	Allocates element storage in an unstructured block. More...
PWP_BOOL	PwUnsBlkSetElement (PWGM_HBLOCK h, const PWP_UINT ndx, const PWGM_ELEMDATA *eData)
	Sets the connectivity for an unstructured block element. More...
PWP_BOOL	PwUnsDomAllocateElementCounts (PWGM_HDOMAIN h, const PWGM_ELEMCOUNTS &counts)
	Allocates element storage in an unstructured domain. More...
PWP_BOOL	PwUnsDomAllocateElements (PWGM_HDOMAIN h, const PWGM_ENUM_ELEMTYPE cellType, const PWP_UINT count)
	Allocates element storage in an unstructured domain. More...
PWP_BOOL	PwUnsDomSetElement (PWGM_HDOMAIN h, const PWP_UINT ndx, const PWGM_ELEMDATA *eData)
	Sets the connectivity for an unstructured domain element. More...
PWP_BOOL	PwVertDataMod (PWGM_HVERTEX vertex, PWGM_VERTDATA *pVertData)
	Get the vertex data relative to the model's index space. More...
PWP_BOOL	PwVertIndexMod (PWGM_HVERTEX vertex, PWP_UINT32 *pIndex)
	Get the vertex index relative to the model's index space. More...
PWP_BOOL	PwVertXyzVal (PWGM_HVERTEX vertex, PWGM_ENUM_XYZ which, PWGM_XYZVAL *pVal)
	Get a vertex's x, y, or z component value. More...
PWP_BOOL	PwVlstAllocate (PWGM_HVERTEXLIST h, const PWP_UINT count)
	Allocates storage in an unstructured vertex list. More...
PWGM_HBLOCKASSEMBLER	PwVlstCreateBlockAssembler (PWGM_HVERTEXLIST h)
	Creates an unstructured block face assembler that uses vertices from an unstructured vertex list. More...
PWGM_HBLOCK	PwVlstCreateUnsBlock (PWGM_HVERTEXLIST h)
	Creates an unstructured block that uses vertices from an unstructured vertex list. More...
PWP_ENUM_DIMENSION	PwVlstGetBlkElemDimensionality (PWGM_HVERTEXLIST h)
	Get the block element dimensionality of a vertex list. More...
PWP_UINT	PwVlstGetIndexDimensionality (PWGM_HVERTEXLIST h)
	Get the index dimensionality of a vertex list. More...
PWP_BOOL	PwVlstIsStructured (PWGM_HVERTEXLIST h)
	Check the type of a vertex list. More...
PWP_BOOL	PwVlstIsUnstructured (PWGM_HVERTEXLIST h)
	Check the type of a vertex list. More...
PWP_BOOL	PwVlstSetXYZ (PWGM_HVERTEXLIST h, const PWP_UINT ndx, const PWGM_XYZVAL x, const PWGM_XYZVAL y, const PWGM_XYZVAL z)
	Set the XYZ of a point in a 1D vertex list. More...
PWP_BOOL	PwVlstSetXYZ2 (PWGM_HVERTEXLIST h, const PWGM_INDEX2 ndx2, const PWGM_XYZVAL x, const PWGM_XYZVAL y, const PWGM_XYZVAL z)
	Set the XYZ of a point in a 2D structured vertex list. More...
PWP_BOOL	PwVlstSetXYZ2Data (PWGM_HVERTEXLIST h, const PWGM_INDEX2 ndx2, const PWGM_VERTDATA &v)
	Set the XYZ of a point in a 2D structured vertex list using a PWGM_VERTDATA value. More...
PWP_BOOL	PwVlstSetXYZ3 (PWGM_HVERTEXLIST h, const PWGM_INDEX3 ndx3, const PWGM_XYZVAL x, const PWGM_XYZVAL y, const PWGM_XYZVAL z)
	Set the XYZ of a point in a 3D structured vertex list. More...
PWP_BOOL	PwVlstSetXYZ3Data (PWGM_HVERTEXLIST h, const PWGM_INDEX3 ndx3, const PWGM_VERTDATA &v)
	Set the XYZ of a point in a 3D structured vertex list using a PWGM_VERTDATA value. More...
PWP_BOOL	PwVlstSetXYZData (PWGM_HVERTEXLIST h, const PWP_UINT ndx, const PWGM_VERTDATA &v)
	Set the XYZ of a point in a 1D vertex list using a PWGM_VERTDATA value. More...
PWP_BOOL	PwVlstSetXYZVal (PWGM_HVERTEXLIST h, const PWP_UINT ndx, const PWGM_ENUM_XYZ which, const PWGM_XYZVAL val)
	Set an XYZ component of a point in a 1D vertex list. More...
PWP_BOOL	PwVlstSetXYZVal2 (PWGM_HVERTEXLIST h, const PWGM_INDEX2 ndx2, const PWGM_ENUM_XYZ which, const PWGM_XYZVAL val)
	Set an XYZ component of a point in a 2D structured vertex list. More...
PWP_BOOL	PwVlstSetXYZVal3 (PWGM_HVERTEXLIST h, const PWGM_INDEX3 ndx3, const PWGM_ENUM_XYZ which, const PWGM_XYZVAL val)
	Set an XYZ component of a point in a 3D structured vertex list. 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...
PWP_BOOL	PwModGetAttributeBOOL (PWGM_HGRIDMODEL model, const char *name, PWP_BOOL *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeEnum (PWGM_HGRIDMODEL model, const char *name, const char **val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeFLOAT (PWGM_HGRIDMODEL model, const char *name, PWP_FLOAT *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeINT (PWGM_HGRIDMODEL model, const char *name, PWP_INT *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeINT32 (PWGM_HGRIDMODEL model, const char *name, PWP_INT32 *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeREAL (PWGM_HGRIDMODEL model, const char *name, PWP_REAL *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeString (PWGM_HGRIDMODEL model, const char *name, const char **val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeUINT (PWGM_HGRIDMODEL model, const char *name, PWP_UINT *val)
	Get an attribute value as a specific type. More...
PWP_BOOL	PwModGetAttributeUINT32 (PWGM_HGRIDMODEL model, const char *name, PWP_UINT32 *val)
	Get an attribute value as a specific type. More...
PWGM_HDOMAIN	PwVlstCreateUnsBoundary (PWGM_HVERTEXLIST h)
PWGM_HDOMAIN	PwVlstCreateUnsDomain (PWGM_HVERTEXLIST h)
	Creates an unstructured domain that uses vertices from an unstructured vertex list. More...

Detailed Description

Pointwise Grid Model API Specification (PWGM-API)

Defines the API used by plugins for read-only access to the grid model data.

Definition in file apiGridModel.h.