Collaboration diagram for Data Types:

Modules
	PWGM-API Opaque Data Handle Types

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_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_POLYELEMDATA
	Polygon or polyhedron element descriptor 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_Polygon(ecs) (ecs).count[PWGM_ELEMTYPE_POLYG]
	Extract the Polygon count from a PWGM_ELEMCOUNTS struct. More...

#define	PWGM_ECNT_Polyhedron(ecs) (ecs).count[PWGM_ELEMTYPE_POLYH]
	Extract the Polyhedron 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_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, PWGM_ELEMTYPE_POLYH, PWGM_ELEMTYPE_POLYG }
	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...

Detailed Description

Macro Definition Documentation

◆ PWGM_CONDKEY_UNDEF

#define PWGM_CONDKEY_UNDEF PWP_UINT32_UNDEF

The "undefined" condition key value.

Definition at line 1192 of file apiGridModel.h.

◆ PWGM_ECNT_Bar

#define PWGM_ECNT_Bar ( ecs ) (ecs).count[PWGM_ELEMTYPE_BAR]

Extract the Bar count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 794 of file apiGridModel.h.

◆ PWGM_ECNT_Hex

#define PWGM_ECNT_Hex ( ecs ) (ecs).count[PWGM_ELEMTYPE_HEX]

Extract the Hex count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 800 of file apiGridModel.h.

◆ PWGM_ECNT_Point

#define PWGM_ECNT_Point ( ecs ) (ecs).count[PWGM_ELEMTYPE_POINT]

Extract the Point count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 788 of file apiGridModel.h.

◆ PWGM_ECNT_Polygon

#define PWGM_ECNT_Polygon ( ecs ) (ecs).count[PWGM_ELEMTYPE_POLYG]

Extract the Polygon count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 842 of file apiGridModel.h.

◆ PWGM_ECNT_Polyhedron

#define PWGM_ECNT_Polyhedron ( ecs ) (ecs).count[PWGM_ELEMTYPE_POLYH]

Extract the Polyhedron count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 836 of file apiGridModel.h.

◆ PWGM_ECNT_Pyramid

#define PWGM_ECNT_Pyramid ( ecs ) (ecs).count[PWGM_ELEMTYPE_PYRAMID]

Extract the Pyramid count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 830 of file apiGridModel.h.

◆ PWGM_ECNT_Quad

#define PWGM_ECNT_Quad ( ecs ) (ecs).count[PWGM_ELEMTYPE_QUAD]

Extract the Quad count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 806 of file apiGridModel.h.

◆ PWGM_ECNT_Tet

#define PWGM_ECNT_Tet ( ecs ) (ecs).count[PWGM_ELEMTYPE_TET]

Extract the Tet count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 818 of file apiGridModel.h.

◆ PWGM_ECNT_Tri

#define PWGM_ECNT_Tri ( ecs ) (ecs).count[PWGM_ELEMTYPE_TRI]

Extract the Tri count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 812 of file apiGridModel.h.

◆ PWGM_ECNT_Wedge

#define PWGM_ECNT_Wedge ( ecs ) (ecs).count[PWGM_ELEMTYPE_WEDGE]

Extract the Wedge count from a PWGM_ELEMCOUNTS struct.

Parameters

ecs	A PWGM_ELEMCOUNTS struct.

Definition at line 824 of file apiGridModel.h.

◆ PWGM_ELEMDATA_VERT_SIZE

#define PWGM_ELEMDATA_VERT_SIZE 8

Maximum number of verts allowed per element.

See also: PWGM_ELEMDATA

Definition at line 730 of file apiGridModel.h.

◆ PWGM_UNSPECIFIED_COND_ID

#define PWGM_UNSPECIFIED_COND_ID PWP_UINT32(2147483647)

The id of the global, Unspecified condition descriptor.

See also: PwBlkCondition(), PwDomCondition(), PWGM_CONDDATA

Definition at line 655 of file apiGridModel.h.

◆ PWGM_UNSPECIFIED_TYPE_ID

#define PWGM_UNSPECIFIED_TYPE_ID PWP_UINT32(0)

The Unspecified physical type id.

See also: PwBlkCondition(), PwDomCondition(), PWGM_CONDDATA

Definition at line 661 of file apiGridModel.h.

Typedef Documentation

◆ PWGM_BEGINSTREAMCB

typedef PWP_UINT32(* PWGM_BEGINSTREAMCB) (PWGM_BEGINSTREAM_DATA *data)

The begin stream callback function signature.

See also: PWGM_ENUM_FACEORDER, PwModStreamFaces

Definition at line 1099 of file apiGridModel.h.

◆ PWGM_CONDKEY

typedef PWP_UINT32 PWGM_CONDKEY

The condition key integral type.

See also: PWGM_ASSEMBLER_DATA, PwAsmSetCondition(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PWGM_CONDKEY_UNDEF

Definition at line 1189 of file apiGridModel.h.

◆ PWGM_ENDSTREAMCB

typedef PWP_UINT32(* PWGM_ENDSTREAMCB) (PWGM_ENDSTREAM_DATA *data)

The face stream callback function signature.

See also: PWGM_ENUM_FACEORDER, PwModStreamFaces

Definition at line 1181 of file apiGridModel.h.

◆ PWGM_FACESTREAMCB

typedef PWP_UINT32(* PWGM_FACESTREAMCB) (PWGM_FACESTREAM_DATA *data)

The face stream callback function signature.

See also: PWGM_ENUM_FACEORDER, PwModStreamFaces

Definition at line 1165 of file apiGridModel.h.

◆ PWGM_INDEX3MAPPERCB

typedef PWGM_INDEX3(* PWGM_INDEX3MAPPERCB) (const PWGM_INDEX3 pwgmNdx, void *data)

The custom, structured Index3Scheme mapper callback function signature.

See also: PwModCustomIndex3SchemeReady

Definition at line 1233 of file apiGridModel.h.

◆ PWGM_INDEXMAPPERCB

typedef PWP_UINT64(* PWGM_INDEXMAPPERCB) (const PWP_UINT64 pwgmNdx, void *data)

The custom, unstructured IndexScheme mapper callback function signature.

See also: PwModCustomIndexSchemeReady

Definition at line 1225 of file apiGridModel.h.

◆ PWGM_STR_SIZE

typedef PWGM_INDEX3 PW_DLL_IMPEXP PWGM_STR_SIZE

Structured grid ijk size data type.

Definition at line 904 of file apiGridModel.h.

◆ PWGM_XYZVAL

typedef PWP_REAL PWGM_XYZVAL

XYZ component data type.

See also: PwVertXyzVal(), PWGM_VERTDATA

Definition at line 600 of file apiGridModel.h.

Enumeration Type Documentation

◆ PWGM_CNXNTYPE

enum PWGM_CNXNTYPE

Structured grid block-point association.

Enumerator
PWGM_CNXNTYPE_ONE_TO_ONE	one-to-one grid point match
PWGM_CNXNTYPE_MANY_TO_ONE	one-to-many grid point match
PWGM_CNXNTYPE_MANY_TO_MANY	many-to-many grid point match
PWGM_CNXNTYPE_NONE	unspecified

Definition at line 961 of file apiGridModel.h.

◆ PWGM_ENUM_ELEMORDER

enum PWGM_ENUM_ELEMORDER

Types of element orderings.

See also: PwModAppendEnumElementOrder()

Enumerator
PWGM_ELEMORDER_HEX	Order by 3D, 6-sided (block) grid element.
PWGM_ELEMORDER_QUAD	Order by 2D, 4-sided grid element.
PWGM_ELEMORDER_TRI	Order by 2D, 3-sided grid element.
PWGM_ELEMORDER_TET	Order by 3D, 4-sided (tetrahedral) grid element.
PWGM_ELEMORDER_WEDGE	Order by 3D, extruded, tri/quad grid element.
PWGM_ELEMORDER_PYRAMID	Order by 3D, 5-sided, quad-based grid element.
PWGM_ELEMORDER_VC	Order by VC id.

Definition at line 699 of file apiGridModel.h.

◆ PWGM_ENUM_ELEMTYPE

enum PWGM_ENUM_ELEMTYPE

Element type ids.

See also: PWGM_ELEMDATA, PwElemDataMod(), PwElemDataModEnum()

Enumerator
PWGM_ELEMTYPE_BAR	1D, linear grid element
PWGM_ELEMTYPE_HEX	3D, 6-sided (block) grid element
PWGM_ELEMTYPE_QUAD	2D, 4-sided grid element
PWGM_ELEMTYPE_TRI	2D, 3-sided grid element
PWGM_ELEMTYPE_TET	3D, 4-sided (tetrahedral) grid element
PWGM_ELEMTYPE_WEDGE	3D, extruded, tri/quad grid element
PWGM_ELEMTYPE_PYRAMID	3D, 5-sided, quad-based grid element
PWGM_ELEMTYPE_POINT	0D, point grid element
PWGM_ELEMTYPE_POLYH	3D, polyhedron
PWGM_ELEMTYPE_POLYG	2D, polygon

Definition at line 672 of file apiGridModel.h.

◆ PWGM_ENUM_FACEORDER

enum PWGM_ENUM_FACEORDER

The orderings supported by face streaming.

Enumerator
PWGM_FACEORDER_DONTCARE	all cell faces in any order
PWGM_FACEORDER_BOUNDARYFIRST	all cell faces in boundary, interior order
PWGM_FACEORDER_INTERIORFIRST	all cell faces in interior, boundary order
PWGM_FACEORDER_BOUNDARYONLY	only boundary cell faces
PWGM_FACEORDER_INTERIORONLY	only interior cell faces
PWGM_FACEORDER_BCGROUPSFIRST	BoundaryFirst grouped by BCs.
PWGM_FACEORDER_BCGROUPSLAST	InteriorFirst grouped by BCs.
PWGM_FACEORDER_BCGROUPSONLY	BoundaryOnly grouped by BCs.
PWGM_FACEORDER_VCGROUPSBCLAST	InteriorFirst grouped by VCs then BCs.
PWGM_FACEORDER_BCGROUPSONLY_BYVC	BoundariesOnly grouped by VCs.

Definition at line 1059 of file apiGridModel.h.

◆ PWGM_ENUM_FACETYPE

enum PWGM_ENUM_FACETYPE

The facetypes supported by face streaming.

Enumerator

PWGM_FACETYPE_BOUNDARY

The cell face is on the grid's boundary.

A neighbor cell does NOT exist.

PWGM_FACETYPE_INTERIOR

The cell face is on the grid's interior.

Both sides of the face have the same volume condition.

PWGM_FACETYPE_CONNECTION

The cell face is on the grid's interior.

Each side of the face has a different volume condition.

Definition at line 1033 of file apiGridModel.h.

◆ PWGM_ENUM_GRIDTYPE

enum PWGM_ENUM_GRIDTYPE

Grid Type IDs

Enumerator
PWGM_GRIDTYPE_STRUCTURED	Structured grid.
PWGM_GRIDTYPE_UNSTRUCTURED	Unstructured grid.

Definition at line 872 of file apiGridModel.h.

◆ PWGM_ENUM_IJK

enum PWGM_ENUM_IJK

IJK component type ids.

Enumerator
PWGM_IJK_I	I-component id.
PWGM_IJK_J	J-component id.
PWGM_IJK_K	K-component id.

Definition at line 1015 of file apiGridModel.h.

◆ PWGM_ENUM_XYZ

enum PWGM_ENUM_XYZ

XYZ component type ids.

See also: PwVertXyzVal()

Enumerator
PWGM_XYZ_X	X-component id.
PWGM_XYZ_Y	Y-component id.
PWGM_XYZ_Z	Z-component id.

Definition at line 850 of file apiGridModel.h.

◆ PWGM_FACE_ID

enum PWGM_FACE_ID

Structured grid block-face ids.

Enumerator
PWGM_FACE_KMIN	min K
PWGM_FACE_KMAX	max K
PWGM_FACE_IMIN	min I
PWGM_FACE_IMAX	max I
PWGM_FACE_JMIN	min J
PWGM_FACE_JMAX	max J
PWGM_FACE_UNSTR	unstructured

Definition at line 939 of file apiGridModel.h.

Modules

Classes

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

◆ PWGM_CONDKEY_UNDEF

◆ PWGM_ECNT_Bar

◆ PWGM_ECNT_Hex

◆ PWGM_ECNT_Point

◆ PWGM_ECNT_Polygon

◆ PWGM_ECNT_Polyhedron

◆ PWGM_ECNT_Pyramid

◆ PWGM_ECNT_Quad

◆ PWGM_ECNT_Tet

◆ PWGM_ECNT_Tri

◆ PWGM_ECNT_Wedge

◆ PWGM_ELEMDATA_VERT_SIZE

◆ PWGM_UNSPECIFIED_COND_ID

◆ PWGM_UNSPECIFIED_TYPE_ID

Typedef Documentation

◆ PWGM_BEGINSTREAMCB

◆ PWGM_CONDKEY

◆ PWGM_ENDSTREAMCB

◆ PWGM_FACESTREAMCB

◆ PWGM_INDEX3MAPPERCB

◆ PWGM_INDEXMAPPERCB

◆ PWGM_STR_SIZE

◆ PWGM_XYZVAL

Enumeration Type Documentation

◆ PWGM_CNXNTYPE

◆ PWGM_ENUM_ELEMORDER

◆ PWGM_ENUM_ELEMTYPE

◆ PWGM_ENUM_FACEORDER

◆ PWGM_ENUM_FACETYPE

◆ PWGM_ENUM_GRIDTYPE

◆ PWGM_ENUM_IJK

◆ PWGM_ENUM_XYZ

◆ PWGM_FACE_ID