Pointwise Plugin SDK
Modules | Classes | Macros | Typedefs | Enumerations
+ 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_STR_RANGE
 Structured grid ijk range data type. More...
 
struct  PWGM_VERTDATA
 Vertex descriptor data type. More...
 

Macros

#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_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_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 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...
 

Detailed Description

Macro Definition Documentation

◆ PWGM_ECNT_Bar

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

Extract the Bar count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 778 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
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 784 of file apiGridModel.h.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PWGM_ECNT_Point

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

Extract the Point count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 772 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
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 814 of file apiGridModel.h.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PWGM_ECNT_Quad

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

Extract the Quad count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 790 of file apiGridModel.h.

Referenced by PwUnsDomAllocateElementCounts().

◆ PWGM_ECNT_Tet

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

Extract the Tet count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 802 of file apiGridModel.h.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PWGM_ECNT_Tri

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

Extract the Tri count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 796 of file apiGridModel.h.

Referenced by PwUnsDomAllocateElementCounts().

◆ PWGM_ECNT_Wedge

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

Extract the Wedge count from a PWGM_ELEMCOUNTS struct.

Parameters
ecsA PWGM_ELEMCOUNTS struct.

Definition at line 808 of file apiGridModel.h.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PWGM_ELEMDATA_VERT_SIZE

#define PWGM_ELEMDATA_VERT_SIZE   8

Maximum number of verts allowed per element.

See also
PWGM_ELEMDATA

Definition at line 729 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 656 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 662 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 1071 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 1153 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 1137 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 876 of file apiGridModel.h.

◆ PWGM_XYZVAL

XYZ component data type.

See also
PwVertXyzVal(), PWGM_VERTDATA

Definition at line 601 of file apiGridModel.h.

Enumeration Type Documentation

◆ 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 933 of file apiGridModel.h.

◆ 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 698 of file apiGridModel.h.

◆ 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

Definition at line 673 of file apiGridModel.h.

◆ 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 1031 of file apiGridModel.h.

◆ 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 1005 of file apiGridModel.h.

◆ PWGM_ENUM_GRIDTYPE

Grid Type IDs

Enumerator
PWGM_GRIDTYPE_STRUCTURED 

Structured grid.

PWGM_GRIDTYPE_UNSTRUCTURED 

Unstructured grid.

Definition at line 844 of file apiGridModel.h.

◆ 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 987 of file apiGridModel.h.

◆ 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 822 of file apiGridModel.h.

◆ 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 911 of file apiGridModel.h.