Collaboration diagram for Common Grid Import Functions:

Functions
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...

PWGM_HVERTEXLIST	PwBlkGetVertexList (PWGM_HBLOCK h)
	Get the vertex list associated with an unstructured or structured block. 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	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...

PWGM_HVERTEXLIST	PwConGetVertexList (PWGM_HCONNECTOR h)
	Get the vertex list associated with a connector. 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...

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

Detailed Description

These functions are used to import both structured and unstructured grids.

See also

Function Documentation

◆ PwAsmSetCellConditionKey()

PWP_BOOL PwAsmSetCellConditionKey	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const PWP_UINT32	cell
	)

Tags a single cells with the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
cell	The Pointwise, zero-based index of an isolated cell. Equivalent to a span where startCell == endCell == cell.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PwAsmSetCellSpanConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1174 of file apiGridModel.cxx.

References PwAsmSetCellSpanConditionKey().

◆ PwAsmSetCellSpanConditionKey()

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.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
startCell	The Pointwise, zero-based index of the first cell in a contiguous span of cells.
endCell	The Pointwise, zero-based index of the last cell in a contiguous span of cells.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PwAsmSetCellConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1163 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwAsmSetCellConditionKey().

◆ PwAsmSetCondition()

PWP_BOOL PwAsmSetCondition	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const PWGM_CONDDATA &	condData
	)

Sets the condition data of the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
condData	A properly initialized PWGM_CONDDATA struct.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCellSpanConditionKey(), PwAsmSetCellConditionKey()

Sample usage:: // Given PWGM_HBLOCKASSEMBLER assembler, tag cells 22-33, and 44 as using

// the condition identified by key.

PWGM_CONDKEY key = 99;

PwAsmSetCellSpanConditionKey(assembler, key, 22, 33);

PwAsmSetCellConditionKey(assembler, key, 44);

// Equivalent to the PwAsmSetCellConditionKey(assembler, key, 44) call above

PwAsmSetCellSpanConditionKey(assembler, key, 44, 44);

// Assign condition information to the condition identified by key.

PwAsmSetConditionUserName(assembler, key, "MyVC");

PwAsmSetConditionUserId(assembler, key, 1);

PwAsmSetConditionTypeName(assembler, key, "Fluid");

PwAsmSetConditionTypeId(assembler, key, 100);

// Equivalent to the previous four calls

PwAsmSetCondition(assembler, key, condData);

Definition at line 1151 of file apiGridModel.cxx.

References PWGM_CONDDATA::id, PWGM_CONDDATA::name, PwAsmSetConditionTypeId(), PwAsmSetConditionTypeName(), PwAsmSetConditionUserId(), PwAsmSetConditionUserName(), PWP_CAST_BOOL, PWGM_CONDDATA::tid, and PWGM_CONDDATA::type.

◆ PwAsmSetConditionTypeId()

PWP_BOOL PwAsmSetConditionTypeId	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const PWP_UINT32	typeId
	)

Sets the type id of the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
typeId	Any solver-valid condition type id. Must be one of the type ids supported by the corresponding CAE exporter.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetCondition(), PwAsmSetCellSpanConditionKey(), PwAsmSetCellConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1141 of file apiGridModel.cxx.

References PwAsmSetProperty().

Referenced by PwAsmSetCondition().

◆ PwAsmSetConditionTypeName()

PWP_BOOL PwAsmSetConditionTypeName	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const char *	typeName
	)

Sets the type name of the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
typeName	Any solver-valid condition type name. Must be one of the type names supported by the corresponding CAE exporter.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionUserId(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PwAsmSetCellSpanConditionKey(), PwAsmSetCellConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1133 of file apiGridModel.cxx.

References PwAsmSetProperty().

Referenced by PwAsmSetCondition().

◆ PwAsmSetConditionUserId()

PWP_BOOL PwAsmSetConditionUserId	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const PWP_UINT32	userId
	)

Sets the user id of the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
userId	The condition user id.

See also: PwAsmSetConditionUserName(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PwAsmSetCellSpanConditionKey(), PwAsmSetCellConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1123 of file apiGridModel.cxx.

References PwAsmSetProperty().

Referenced by PwAsmSetCondition().

◆ PwAsmSetConditionUserName()

PWP_BOOL PwAsmSetConditionUserName	(	PWGM_HBLOCKASSEMBLER	assembler,
		const PWGM_CONDKEY	key,
		const char *	userName
	)

Sets the user name of the condition identified by key.

Returns: PWP_TRUE on success.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler().
key	A plugin-defined condition identifier key. This corresponds to the key associated with each boundary or volume element.
userName	Any pointwise-valid condition user name.

See also: PwAsmSetConditionUserId(), PwAsmSetConditionTypeName(), PwAsmSetConditionTypeId(), PwAsmSetCondition(), PwAsmSetCellSpanConditionKey(), PwAsmSetCellConditionKey()

Sample usage:: See PwAsmSetCondition() for an example.

Definition at line 1115 of file apiGridModel.cxx.

References PwAsmSetProperty().

Referenced by PwAsmSetCondition().

◆ PwAsmSetProperty()

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.

Parameters

assembler	A handle obtained from PwVlstCreateBlockAssembler()
propertySetId	Plugin-defined id that identifies a collection of named properties
key	The property name. Can be any value. However, the Pointwise core only recognizes and uses certain keys.
val	The property value. Can be any key-appropriate value.

Returns: PWP_TRUE on success.

See also: PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition(), PwAsmSetCondition(), PwBlkSetProperty(), PwDomSetProperty(), PwConSetProperty()

Sample usage:: // The same key name with different values can exist in differnt property sets

PwAsmSetProperty(hAsm, 99, "MyAsmKey", "SomeValue99");

PwAsmSetProperty(hAsm, 65, "MyAsmKey", "SomeValue65");

Definition at line 976 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwAsmSetConditionTypeId(), PwAsmSetConditionTypeName(), PwAsmSetConditionUserId(), and PwAsmSetConditionUserName().

◆ PwBlkGetVertexList()

PWGM_HVERTEXLIST PwBlkGetVertexList ( PWGM_HBLOCK h )

Get the vertex list associated with an unstructured or structured block.

Parameters

h	A block handle obtained from PwVlstCreateUnsBlock() or PwModCreateStrBlock().

Returns: A vertex list handle.

See also: PwDomGetVertexList(), PwConGetVertexList(), PwVlstGetIndexDimensionality()

Sample usage:: PWGM_HVERTEXLIST hVlst = createAndLoadUnsVertexList(model);

PWGM_HBLOCK hUnsBlk = PwVlstCreateUnsBlock(hVlst);

PWGM_HVERTEXLIST hVlst2 = PwBlkGetVertexList(hUnsBlk); // hVlst == hVlst2

PwVlstGetIndexDimensionality(hVlst2); // returns 1

PWGM_STR_SIZE size = {10, 20, 30};

PWGM_HBLOCK hStrBlk = PwModCreateStrBlock(model, size);

PWGM_HVERTEXLIST hVlst3 = PwBlkGetVertexList(hStrBlk);

PwVlstGetIndexDimensionality(hVlst3); // returns 3

Definition at line 778 of file apiGridModel.cxx.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PwBlkSetCondition()

PWP_BOOL PwBlkSetCondition	(	PWGM_HBLOCK	block,
		const PWGM_CONDDATA &	condData
	)

Sets the condition data for a grid entity.

Parameters

block	A handle obtained from PwModCreateBlock().
condData	A properly initialized PWGM_CONDDATA struct.

Returns: PWP_TRUE on success.

See also: PwBlkSetConditionUserName(), PwBlkSetConditionUserId(), PwBlkSetConditionTypeName(), PwBlkSetConditionTypeId(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: // Given PWGM_HBLOCK block, assign condition information to block.

PwBlkSetConditionUserName(block, "MyVC");

PwBlkSetConditionUserId(block, 1);

PwBlkSetConditionTypeName(block, "Fluid");

PwBlkSetConditionTypeId(block, 100);

// Equivalent to the four calls above

const PWGM_CONDDATA condData{ "MyVC", 1, "Fluid", 100 };

PwBlkSetCondition(block, condData);

Definition at line 1018 of file apiGridModel.cxx.

References PWGM_CONDDATA::id, PWGM_CONDDATA::name, PwBlkSetConditionTypeId(), PwBlkSetConditionTypeName(), PwBlkSetConditionUserId(), PwBlkSetConditionUserName(), PWP_CAST_BOOL, PWGM_CONDDATA::tid, and PWGM_CONDDATA::type.

◆ PwBlkSetConditionTypeId()

PWP_BOOL PwBlkSetConditionTypeId	(	PWGM_HBLOCK	block,
		const PWP_UINT32	typeId
	)

Sets the condition data for a grid entity.

Parameters

block	A handle obtained from PwModCreateBlock().
typeId	Any solver-valid condition type id. Must be one of the type ids supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwBlkSetConditionUserName(), PwBlkSetConditionUserId(), PwBlkSetConditionTypeName(), PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: See PwBlkSetCondition() for an example.

Definition at line 1009 of file apiGridModel.cxx.

References PwBlkSetProperty().

Referenced by PwBlkSetCondition().

◆ PwBlkSetConditionTypeName()

PWP_BOOL PwBlkSetConditionTypeName	(	PWGM_HBLOCK	block,
		const char *	typeName
	)

Sets the condition data for a grid entity.

Parameters

block	A handle obtained from PwModCreateBlock().
typeName	Any solver-valid condition type name. Must be one of the type names supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwBlkSetConditionUserName(), PwBlkSetConditionUserId(), PwBlkSetConditionTypeId(), PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: See PwBlkSetCondition() for an example.

Definition at line 1002 of file apiGridModel.cxx.

References PwBlkSetProperty().

Referenced by PwBlkSetCondition().

◆ PwBlkSetConditionUserId()

PWP_BOOL PwBlkSetConditionUserId	(	PWGM_HBLOCK	block,
		const PWP_UINT32	userId
	)

Sets the condition data for a grid entity.

Parameters

block	A handle obtained from PwModCreateBlock().
userId	The condition user id.

Returns: PWP_TRUE on success.

See also: PwBlkSetConditionUserName(), PwBlkSetConditionTypeName(), PwBlkSetConditionTypeId(), PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: See PwBlkSetCondition() for an example.

Definition at line 993 of file apiGridModel.cxx.

References PwBlkSetProperty().

Referenced by PwBlkSetCondition().

◆ PwBlkSetConditionUserName()

PWP_BOOL PwBlkSetConditionUserName	(	PWGM_HBLOCK	block,
		const char *	userName
	)

Sets the condition name for a grid entity.

Parameters

block	A handle obtained from PwModCreateBlock().
userName	Any pointwise-valid condition user name.

Returns: PWP_TRUE on success.

See also: PwBlkSetConditionUserId(), PwBlkSetConditionTypeName(), PwBlkSetConditionTypeId(), PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: See PwBlkSetCondition() for an example.

Definition at line 986 of file apiGridModel.cxx.

References PwBlkSetProperty().

Referenced by PwBlkSetCondition().

◆ PwBlkSetName()

PWP_BOOL PwBlkSetName	(	PWGM_HBLOCK	h,
		const char *	name
	)

Set a block's name.

Parameters

h	A block handle obtained from PwModCreateBlock().
name	The entity name. A numeric "-n" suffix will be silently added to the name if it is a duplicate.

Returns: PWP_TRUE on success.

See also: PwConSetName(), PwDomSetName()

Definition at line 810 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwBlkSetProperty()

PWP_BOOL PwBlkSetProperty	(	PWGM_HBLOCK	block,
		const char *	key,
		const char *	val
	)

Sets the text value of a property identified by key.

Parameters

block	A handle obtained from PwModCreateBlock()
key	The property name. Can be any value. However, the Pointwise core only recognizes and uses certain keys.
val	The property value. Can be any key-appropriate value.

Returns: PWP_TRUE on success.

See also: PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition(), PwAsmSetCondition(), PwDomSetProperty(), PwConSetProperty(), PwAsmSetProperty()

Sample usage:: PwBlkSetProperty(hBlk, "MyBlkKey", "SomeValue1");

Definition at line 952 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwBlkSetConditionTypeId(), PwBlkSetConditionTypeName(), PwBlkSetConditionUserId(), and PwBlkSetConditionUserName().

◆ PwConGetVertexList()

PWGM_HVERTEXLIST PwConGetVertexList ( PWGM_HCONNECTOR h )

Get the vertex list associated with a connector.

Parameters

h	A connector handle obtained from PwModCreateCon().

Returns: A vertex list handle.

See also: PwBlkGetVertexList(), PwDomGetVertexList(), PwVlstGetIndexDimensionality()

Sample usage:: PWGM_HCONNECTOR hCon = PwModCreateCon(model, 10);

PWGM_HVERTEXLIST hVlst = PwConGetVertexList(hCon);

PwVlstGetIndexDimensionality(hVlst); // returns 1

Definition at line 794 of file apiGridModel.cxx.

◆ PwConSetCondition()

PWP_BOOL PwConSetCondition	(	PWGM_HCONNECTOR	connector,
		const PWGM_CONDDATA &	condData
	)

Sets the condition data for a connector.

Parameters

connector	A handle obtained from PwModCreateConnector().
condData	A properly initialized PWGM_CONDDATA struct.

Returns: PWP_TRUE on success.

See also: PwConSetConditionUserName(), PwConSetConditionUserId(), PwConSetConditionTypeName(), PwConSetConditionTypeId(), PwConSetCondition(), PwDomSetCondition()

Sample usage:: // Given PWGM_HCONNECTOR connector, assign condition information to connector.

PwConSetConditionUserName(connector, "MyVC");

PwConSetConditionUserId(connector, 1);

PwConSetConditionTypeName(connector, "Fluid");

PwConSetConditionTypeId(connector, 100);

// Equivalent to the four calls above

const PWGM_CONDDATA condData{ "MyVC", 1, "Fluid", 100 };

PwConSetCondition(connector, condData);

Definition at line 1104 of file apiGridModel.cxx.

References PWGM_CONDDATA::id, PWGM_CONDDATA::name, PwConSetConditionTypeId(), PwConSetConditionTypeName(), PwConSetConditionUserId(), PwConSetConditionUserName(), PWP_CAST_BOOL, PWGM_CONDDATA::tid, and PWGM_CONDDATA::type.

◆ PwConSetConditionTypeId()

PWP_BOOL PwConSetConditionTypeId	(	PWGM_HCONNECTOR	connector,
		const PWP_UINT32	typeId
	)

Sets the condition data for a connector.

Parameters

connector	A handle obtained from PwModCreateConnector().
typeId	Any solver-valid condition type id. Must be one of the type ids supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwConSetConditionUserName(), PwConSetConditionUserId(), PwConSetConditionTypeName(), PwConSetCondition(), PwBlkSetCondition(), PwDomSetCondition()

Sample usage:: See PwConSetCondition() for an example.

Definition at line 1095 of file apiGridModel.cxx.

References PwConSetProperty().

Referenced by PwConSetCondition().

◆ PwConSetConditionTypeName()

PWP_BOOL PwConSetConditionTypeName	(	PWGM_HCONNECTOR	connector,
		const char *	typeName
	)

Sets the condition data for a connector.

Parameters

connector	A handle obtained from PwModCreateConnector().
typeName	Any solver-valid condition type name. Must be one of the type names supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwConSetConditionUserName(), PwConSetConditionUserId(), PwConSetConditionTypeId(), PwConSetCondition(), PwBlkSetCondition(), PwDomSetCondition()

Sample usage:: See PwConSetCondition() for an example.

Definition at line 1088 of file apiGridModel.cxx.

References PwConSetProperty().

Referenced by PwConSetCondition().

◆ PwConSetConditionUserId()

PWP_BOOL PwConSetConditionUserId	(	PWGM_HCONNECTOR	connector,
		const PWP_UINT32	userId
	)

Sets the condition data for a connector.

Parameters

connector	A handle obtained from PwModCreateConnector().
userId	The condition user id.

Returns: PWP_TRUE on success.

See also: PwConSetConditionUserName(), PwConSetConditionTypeName(), PwConSetConditionTypeId(), PwConSetCondition(), PwBlkSetCondition(), PwDomSetCondition()

Sample usage:: See PwConSetCondition() for an example.

Definition at line 1079 of file apiGridModel.cxx.

References PwConSetProperty().

Referenced by PwConSetCondition().

◆ PwConSetConditionUserName()

PWP_BOOL PwConSetConditionUserName	(	PWGM_HCONNECTOR	connector,
		const char *	userName
	)

Sets the condition name for a connector.

Parameters

connector	A handle obtained from PwModCreateConnector().
userName	Any pointwise-valid condition user name.

Returns: PWP_TRUE on success.

See also: PwConSetConditionUserId(), PwConSetConditionTypeName(), PwConSetConditionTypeId(), PwConSetCondition(), PwBlkSetCondition(), PwDomSetCondition()

Sample usage:: See PwConSetCondition() for an example.

Definition at line 1072 of file apiGridModel.cxx.

References PwConSetProperty().

Referenced by PwConSetCondition().

◆ PwConSetName()

PWP_BOOL PwConSetName	(	PWGM_HCONNECTOR	h,
		const char *	name
	)

Set a connector's name.

Parameters

h	A connector handle obtained from PwModCreateCon().
name	The entity name. A numeric "-n" suffix will be silently added to the name if it is a duplicate.

Returns: PWP_TRUE on success.

See also: PwBlkSetName(), PwDomSetName()

Definition at line 802 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwConSetProperty()

PWP_BOOL PwConSetProperty	(	PWGM_HCONNECTOR	connector,
		const char *	key,
		const char *	val
	)

Sets the text value of a property identified by key.

Parameters

connector	A handle obtained from PwModCreateConnector()
key	The property name. Can be any value. However, the Pointwise core only recognizes and uses certain keys.
val	The property value. Can be any key-appropriate value.

Returns: PWP_TRUE on success.

See also: PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition(), PwAsmSetCondition(), PwBlkSetProperty(), PwDomSetProperty(), PwAsmSetProperty()

Sample usage:: PwConSetProperty(hCon, "MyConKey", "SomeValue3");

Definition at line 968 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwConSetConditionTypeId(), PwConSetConditionTypeName(), PwConSetConditionUserId(), and PwConSetConditionUserName().

◆ PwDomGetVertexList()

PWGM_HVERTEXLIST PwDomGetVertexList ( PWGM_HDOMAIN h )

Get the vertex list associated with an unstructured or structured domain.

Parameters

h	A domain handle obtained from PwVlstCreateUnsDomain(), PwVlstCreateUnsBoundary(), or PwModCreateStrDomain().

Returns: A vertex list handle.

See also: PwBlkGetVertexList(), PwConGetVertexList(), PwVlstGetIndexDimensionality()

Sample usage:: PWGM_HVERTEXLIST hVlst = createAndLoadUnsVertexList(model);

PWGM_HDOMAIN hUnsDom = PwVlstCreateUnsDomain(hVlst);

PWGM_HVERTEXLIST hVlst2 = PwDomGetVertexList(hUnsDom); // hVlst == hVlst2

PwVlstGetIndexDimensionality(hVlst2); // returns 1

PWGM_STR_SIZE size = {10, 20}; // k is ignored

PWGM_HDOMAIN hStrDom = PwModCreateStrDomain(model, size);

PWGM_HVERTEXLIST hVlst3 = PwDomGetVertexList(hStrDom);

PwVlstGetIndexDimensionality(hVlst3); // returns 2

Definition at line 786 of file apiGridModel.cxx.

◆ PwDomSetCondition()

PWP_BOOL PwDomSetCondition	(	PWGM_HDOMAIN	domain,
		const PWGM_CONDDATA &	condData
	)

Sets the condition data for a domain.

Parameters

domain	A handle obtained from PwModCreateDomain().
condData	A properly initialized PWGM_CONDDATA struct.

Returns: PWP_TRUE on success.

See also: PwDomSetConditionUserName(), PwDomSetConditionUserId(), PwDomSetConditionTypeName(), PwDomSetConditionTypeId(), PwDomSetCondition(), PwConSetCondition()

Sample usage:: // Given PWGM_HDOMAIN domain, assign condition information to domain.

PwDomSetConditionUserName(domain, "MyVC");

PwDomSetConditionUserId(domain, 1);

PwDomSetConditionTypeName(domain, "Fluid");

PwDomSetConditionTypeId(domain, 100);

// Equivalent to the four calls above

const PWGM_CONDDATA condData{ "MyVC", 1, "Fluid", 100 };

PwDomSetCondition(domain, condData);

Definition at line 1061 of file apiGridModel.cxx.

References PWGM_CONDDATA::id, PWGM_CONDDATA::name, PwDomSetConditionTypeId(), PwDomSetConditionTypeName(), PwDomSetConditionUserId(), PwDomSetConditionUserName(), PWP_CAST_BOOL, PWGM_CONDDATA::tid, and PWGM_CONDDATA::type.

◆ PwDomSetConditionTypeId()

PWP_BOOL PwDomSetConditionTypeId	(	PWGM_HDOMAIN	domain,
		const PWP_UINT32	typeId
	)

Sets the condition data for a domain.

Parameters

domain	A handle obtained from PwModCreateDomain().
typeId	Any solver-valid condition type id. Must be one of the type ids supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwDomSetConditionUserName(), PwDomSetConditionUserId(), PwDomSetConditionTypeName(), PwDomSetCondition(), PwBlkSetCondition(), PwConSetCondition()

Sample usage:: See PwDomSetCondition() for an example.

Definition at line 1052 of file apiGridModel.cxx.

References PwDomSetProperty().

Referenced by PwDomSetCondition().

◆ PwDomSetConditionTypeName()

PWP_BOOL PwDomSetConditionTypeName	(	PWGM_HDOMAIN	domain,
		const char *	typeName
	)

Sets the condition data for a domain.

Parameters

domain	A handle obtained from PwModCreateDomain().
typeName	Any solver-valid condition type name. Must be one of the type names supported by the corresponding CAE exporter.

Returns: PWP_TRUE on success.

Note: Only one of typeName or typeId are required. If both are defined, typeName will be take precedence over typeId. If niether typeName nor typeId is defined or they are both not valid for the solver, the condition will silently revert to the Unspecified type.

See also: PwDomSetConditionUserName(), PwDomSetConditionUserId(), PwDomSetConditionTypeId(), PwDomSetCondition(), PwBlkSetCondition(), PwConSetCondition()

Sample usage:: See PwDomSetCondition() for an example.

Definition at line 1045 of file apiGridModel.cxx.

References PwDomSetProperty().

Referenced by PwDomSetCondition().

◆ PwDomSetConditionUserId()

PWP_BOOL PwDomSetConditionUserId	(	PWGM_HDOMAIN	domain,
		const PWP_UINT32	userId
	)

Sets the condition data for a domain.

Parameters

domain	A handle obtained from PwModCreateDomain().
userId	The condition user id.

Returns: PWP_TRUE on success.

See also: PwDomSetConditionUserName(), PwDomSetConditionTypeName(), PwDomSetConditionTypeId(), PwDomSetCondition(), PwBlkSetCondition(), PwConSetCondition()

Sample usage:: See PwDomSetCondition() for an example.

Definition at line 1036 of file apiGridModel.cxx.

References PwDomSetProperty().

Referenced by PwDomSetCondition().

◆ PwDomSetConditionUserName()

PWP_BOOL PwDomSetConditionUserName	(	PWGM_HDOMAIN	domain,
		const char *	userName
	)

Sets the condition name for a domain.

Parameters

domain	A handle obtained from PwModCreateDomain().
userName	Any pointwise-valid condition user name.

Returns: PWP_TRUE on success.

See also: PwDomSetConditionUserId(), PwDomSetConditionTypeName(), PwDomSetConditionTypeId(), PwDomSetCondition(), PwBlkSetCondition(), PwConSetCondition()

Sample usage:: See PwDomSetCondition() for an example.

Definition at line 1029 of file apiGridModel.cxx.

References PwDomSetProperty().

Referenced by PwDomSetCondition().

◆ PwDomSetName()

PWP_BOOL PwDomSetName	(	PWGM_HDOMAIN	h,
		const char *	name
	)

Set a domain's name.

Parameters

h	A domain handle obtained from PwModCreateDomain().
name	The entity name. A numeric "-n" suffix will be silently added to the name if it is a duplicate.

Returns: PWP_TRUE on success.

See also: PwConSetName(), PwBlkSetName()

Definition at line 818 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwDomSetProperty()

PWP_BOOL PwDomSetProperty	(	PWGM_HDOMAIN	domain,
		const char *	key,
		const char *	val
	)

Sets the text value of a property identified by key.

Parameters

domain	A handle obtained from PwModCreateDomain()
key	The property name. Can be any value. However, the Pointwise core only recognizes and uses certain keys.
val	The property value. Can be any key-appropriate value.

Returns: PWP_TRUE on success.

See also: PwBlkSetCondition(), PwDomSetCondition(), PwConSetCondition(), PwAsmSetCondition(), PwBlkSetProperty(), PwConSetProperty(), PwAsmSetProperty()

Sample usage:: PwDomSetProperty(hDom, "MyDomKey", "SomeValue2");

Definition at line 960 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwDomSetConditionTypeId(), PwDomSetConditionTypeName(), PwDomSetConditionUserId(), PwDomSetConditionUserName(), and PwVlstCreateUnsBoundary().

◆ PwVlstGetBlkElemDimensionality()

PWP_ENUM_DIMENSION PwVlstGetBlkElemDimensionality ( PWGM_HVERTEXLIST h )

Get the block element dimensionality of a vertex list.

Parameters

h	A vertex list handle.

Returns: Returns PWP_DIMENSION_3D if blocks contain 3-D elements (tet, pyramid, etc) and domains contain 2-D elements (tri, quad).

PWP_DIMENSION_2D if blocks contain 2-D elements (tri, quad) and domains contain 1-D bar elements.

Definition at line 850 of file apiGridModel.cxx.

Referenced by PwUnsBlkAllocateElementCounts().

◆ PwVlstGetIndexDimensionality()

PWP_UINT PwVlstGetIndexDimensionality ( PWGM_HVERTEXLIST h )

Get the index dimensionality of a vertex list.

Parameters

h	A vertex list handle.

Returns: Returns 3, 2, or 1 if the vertex list uses ijk (3-D structured), ij (2-D structured), or i (unstructured) indexing respectively.

Definition at line 842 of file apiGridModel.cxx.

◆ PwVlstIsStructured()

PWP_BOOL PwVlstIsStructured ( PWGM_HVERTEXLIST h )

Check the type of a vertex list.

Parameters

h	A vertex list handle.

Returns: PWP_TRUE if vertex list h is structured.

See also: PwVlstIsUnstructured()

Definition at line 834 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwVlstIsUnstructured()

PWP_BOOL PwVlstIsUnstructured ( PWGM_HVERTEXLIST h )

Check the type of a vertex list.

Parameters

h	A vertex list handle.

Returns: PWP_TRUE if vertex list h is unstructured.

See also: PwVlstIsStructured()

Definition at line 826 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwVlstSetXYZ()

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.

Parameters

h	A vertex list handle. The vertext list can be either 1D structured or unstructured.
ndx	The index into the vertex list.
x,y,z	The component values.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZVal(), PwVlstSetXYZData()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWP_UINT ndx = 0;

PwVlstSetXYZVal(hVlst, ndx, 1.0, 2.0, 3.0);

Definition at line 870 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwVlstSetXYZ2()

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.

Parameters

h	A vertex list handle.
ndx2	The index into the vertex list.
x,y,z	The component values.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZVal2(), PwVlstSetXYZ2Data()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX2 ndx2 = {0, 0}; // {i, j}

PwVlstSetXYZ2(hVlst, ndx2, 1.0, 2.0, 3.0);

Definition at line 902 of file apiGridModel.cxx.

References PWGM_INDEX2::i, PWGM_INDEX2::j, and PWP_FALSE.

◆ PwVlstSetXYZ2Data()

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.

Parameters

h	A vertex list handle.
ndx2	The index into the vertex list.
v	A PWGM_VERTDATA value. Only the v.x, v.y, and v.z values are used. The v.i value is ignored.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZVal2(), PwVlstSetXYZ2()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX2 ndx2 = {0, 0}; // {i, j}

PWGM_VERTDATA v = {1.0, 2.0, 3.0}; // {x, y, z, i} i is ignored

PwVlstSetXYZ2(hVlst, ndx2, v);

Definition at line 912 of file apiGridModel.cxx.

References PWGM_INDEX2::i, PWGM_INDEX2::j, PWP_FALSE, PWGM_VERTDATA::x, PWGM_VERTDATA::y, and PWGM_VERTDATA::z.

◆ PwVlstSetXYZ3()

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.

Parameters

h	A vertex list handle.
ndx3	The index into the vertex list.
x,y,z	The component values.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZVal3(), PwVlstSetXYZ3Data()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX3 ndx3 = {0, 0, 0}; // {i, j, k}

PwVlstSetXYZ3(hVlst, ndx3, 1.0, 2.0, 3.0);

Definition at line 933 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwVlstSetXYZ3Data()

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.

Parameters

h	A vertex list handle.
ndx3	The index into the vertex list.
v	A PWGM_VERTDATA value. Only the v.x, v.y, and v.z values are used. The v.i value is ignored.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZVal3(), PwVlstSetXYZ3()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX3 ndx3 = {0, 0, 0}; // {i, j, k}

PWGM_VERTDATA v = {1.0, 2.0, 3.0}; // {x, y, z, i} i is ignored

PwVlstSetXYZ3(hVlst, ndx3, v);

Definition at line 942 of file apiGridModel.cxx.

References PWP_FALSE, PWGM_VERTDATA::x, PWGM_VERTDATA::y, and PWGM_VERTDATA::z.

◆ PwVlstSetXYZData()

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.

Parameters

h	A vertex list handle.
ndx	The index into the vertex list.
v	A PWGM_VERTDATA value. Only the v.x, v.y, and v.z values are used. The v.i value is ignored.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZ(), PwVlstSetXYZVal()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWP_UINT ndx = 0;

PWGM_VERTDATA v = {1.0, 2.0, 3.0}; // {x, y, z, i} i is ignored

PwVlstSetXYZData(hVlst, ndx, v);

Definition at line 880 of file apiGridModel.cxx.

References PWP_FALSE, PWGM_VERTDATA::x, PWGM_VERTDATA::y, and PWGM_VERTDATA::z.

◆ PwVlstSetXYZVal()

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.

Parameters

h	A vertex list handle.
ndx	The index into the vertex list.
which	The XYZ component to set.
val	The XYZ component value.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZ(), PwVlstSetXYZData()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWP_UINT ndx = 0;

PwVlstSetXYZVal(hVlst, ndx, PWGM_XYZ_X, 1.0);

PwVlstSetXYZVal(hVlst, ndx, PWGM_XYZ_Y, 2.0);

PwVlstSetXYZVal(hVlst, ndx, PWGM_XYZ_Z, 3.0);

Definition at line 859 of file apiGridModel.cxx.

References PWP_FALSE.

◆ PwVlstSetXYZVal2()

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.

Parameters

h	A vertex list handle.
ndx2	The index into the vertex list.
which	The XYZ component to set.
val	The XYZ component value.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZ2(), PwVlstSetXYZ2Data()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX2 ndx2 = {0, 0}; // {i, j}

PwVlstSetXYZVal2(hVlst, ndx2, PWGM_XYZ_X, 1.0);

PwVlstSetXYZVal2(hVlst, ndx2, PWGM_XYZ_Y, 2.0);

PwVlstSetXYZVal2(hVlst, ndx2, PWGM_XYZ_Z, 3.0);

Definition at line 891 of file apiGridModel.cxx.

References PWGM_INDEX2::i, PWGM_INDEX2::j, and PWP_FALSE.

◆ PwVlstSetXYZVal3()

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.

Parameters

h	A vertex list handle.
ndx3	The index into the vertex list.
which	The XYZ component to set.
val	The XYZ component value.

Returns: PWP_TRUE on success.

See also: PwVlstSetXYZ3(), PwVlstSetXYZ3Data()

Sample usage:: // given a PWGM_HVERTEXLIST hVlst

PWGM_INDEX3 ndx3 = {0, 0, 0}; // {i, j, k}

PwVlstSetXYZVal3(hVlst, ndx3, PWGM_XYZ_X, 1.0);

PwVlstSetXYZVal3(hVlst, ndx3, PWGM_XYZ_Y, 2.0);

PwVlstSetXYZVal3(hVlst, ndx3, PWGM_XYZ_Z, 3.0);

Definition at line 923 of file apiGridModel.cxx.

References PWP_FALSE.