pw::Block

A block is a volume grid bounded by one or more pw::Faces.

Derives From

pw::Object pw::Entity pw::GridEntity

Summary
pw::BlockA block is a volume grid bounded by one or more pw::Faces.
Static Actions
getAdjacentBlocksThis action finds blocks adjacent to a starting list of blocks.
getBlocksFromDomainsThis action returns a list of blocks that use the given domains.
setSortOrderThis action sets the user specified sort order of blocks.
Instance Actions
deleteThis action deletes this block.
initializeThis action initializes the interior points of this block.
getInteriorStateThis action gets the interior state of this block.
getDimensionsThis action gets the dimension of this block.
getPointThis action gets the position of a block grid point.
setPointThis action sets the position of a block interior grid point.
isInteriorIndexThis action checks to see if an index corresponds to a point in the interior of the block.
getAdjacentIndicesThis action returns the indices that are directly connected to the specified index.
getCellsUsingIndexThis action returns the indices that are directly connected to the specified index.
getPositionThis action gets the position in the defining space of the block at the given index.
getXYZThis action gets the position of the block in model space at the given index.
getCellCountThis action gets the number of cells in this block.
getCellThis action gets the indices of the given cell.
getCellAverageEdgeLengthThis action gets the average edge length of the given cell.
getCellCentroidThis action gets the centroid of the given cell.
getCellVolumeThis action gets the volume of the given cell.
getFaceCountThis action gets the number of faces in this block.
getFaceThis action gets the face at the given index.
getFacesThis action gets the face list.
addFaceThis action adds a face to the block.
removeLastFaceThis action removes the last face added to this block.
isValidThis action checks to see if the block has a valid face definition.
Overset Data Actions
clearOversetDataThis action clears overset grid assembly data from the block.
getIblankThis action returns the IBLANK data for a block.
getIblankTypeThis action returns the IBLANK type for a block.
getOversetIndexListThis action returns the list of original block indices for a given overset object type.
getOversetDataDimensionsThis action returns the original block point or cell dimensions used by the most recent import of overset assembly data.
isOversetDataUpToDateThis action returns whether the overset data for a block is up to date.
getHighOrderSolverAttributeThis action gets the named high order solver attribute.
setHighOrderSolverAttributeThis action sets the named high order solver attribute.
High Order Solver Attributes
ConvergenceCostThresholdThe threshold value for the minimum curving cost smoothing function.
DeviationThresholdThe maximum threshold for deviation.
FreezeSurfaceNodesControls which linear and inserted and projected, high-order surface nodes can be moved during smoothing.
PolynomialDegreeMinSpecifies a minimum polynomial degree for mixed order mesh elevation.
PolynomialDegreeMaxSpecifies the polynomial degree for constant order mesh elevation or the maximum polynomial degree for mixed order mesh elevation.
StepSizeRelaxationFactorThe step size factor used when smoothing the high-order nodes.
Static Defaults
ConvergenceCostThreshold (Default)The default minimum curving cost threshold value assigned to a block when it is created.
DeviationThreshold (Default)The default deviation threshold value assigned to a block when it is created.
FreezeSurfaceNodes (Default)The default freeze method value assigned to a block when it is created.
PolynomialDegreeMin (Default)The default minimum polynomial degree value assigned to a block when it is created.
PolynomialDegreeMax (Default)The default max polynomial degree value assigned to a block when it is created.
StepSizeRelaxationFactor (Default)The default step size factor value assigned to a block when it is created.
getOversetDataThis action returns overset data of the given type at the specified index.
Overset Data Types
VolumeReturn the volume for an overset data object.
VertexListReturn the list of vertices for an overset data object.
DonorReturn the donor information for an overset fringe object.
DonorCandidateListReturn the donor candidate information for an overset fringe or orphan object.

Static Actions

getAdjacentBlocks

pw::Block getAdjacentBlocks ?-all? blocks

This action finds blocks adjacent to a starting list of blocks.

Parameters

-allThis optional flag is a notification to repeat the search on the adjacent blocks found until there are no more adjacent blocks.
blocksThis required parameter is a list of starting pw::Block objects.

Returns

This action returns the list of adjacent pw::Block objects found.

Information

The returned list will not include any blocks specified in the original blocks list.

getBlocksFromDomains

pw::Block getBlocksFromDomains domains

This action returns a list of blocks that use the given domains.

Parameters

domainsThis required parameter is a list of pw::Domain objects.

Returns

This action returns a list of pw::Block objects.

setSortOrder

pw::Block setSortOrder blocks

This action sets the user specified sort order of blocks.

Parameters

blocksThis required parameter is a list of pw::Block objects and the order they should appear in for sorting.

Returns

This action returns nothing.

Information

Any blocks that are not in the given list, or that are created after calling this command will be placed after these entities in the sort order by the pw::Entity.sort action.

See Also

pw::Entity.sort, pw::Domain.setSortOrder

Instance Actions

delete

$block delete ?-force? ?-domains? ?-connectors?

This action deletes this block.

Parameters

-forceThis optional flag is a notification to delete the entity as well as higher level entities that depend on this entity.
-domainsThis optional flag is a notification to delete the block domains if they will be left orphaned.
-connectorsThis optional flag is a notification to delete the block connectors if they will be left orphaned.  The -domains flag must be present for this flag to have any effect.

Returns

This action returns nothing.

See Also

pw::Entity.delete

initialize

$block initialize

This action initializes the interior points of this block.

Parameters

There are no parameters.

Returns

This action returns nothing.

getInteriorState

$block getInteriorState

This action gets the interior state of this block.

Parameters

There are no parameters.

Returns

This action returns a string with options < Empty | Incomplete | Initialized | Locked | Refined >.

getDimensions

$block getDimensions

This action gets the dimension of this block.

Parameters

There are no parameters.

Returns

This action returns the block dimensions as a three-element integer list.  Unstructured blocks have second and third dimensions of 1: [N 1 1].

getPoint

$block getPoint ?-constrained constrainedVar? index

This action gets the position of a block grid point.

Parameters

indexThis required parameter is the integer linear index of the grid point to get with the range [1, number of points].
-constrained constrainedVarThis optional parameter is the string name of a variable.  If the grid point is database constrained, this variable is set to true.  If not constrained, it is set to false.

Returns

This action returns a point giving the grid point position (may be in the form “u v dbentity”).

Information

Block points are not currently db-constrained, so this command returns only XYZ coordinates.

setPoint

$block setPoint index point

This action sets the position of a block interior grid point.

Parameters

indexThis required parameter is the integer linear index of the grid point to set with the range [1, number of points].  The index must be for an interior grid point.
pointThis required parameter is the new point value of the grid point.

Returns

This action returns nothing.

Information

Block points are not currently db-constrained, so any database information in the point argument is converted to pure XYZ data before being stored.

isInteriorIndex

$block isInteriorIndex index

This action checks to see if an index corresponds to a point in the interior of the block.

Parameters

indexThis required parameter is the integer linear index of the grid point to check with the range [1, number of points].

Returns

This action returns true if the index refers to an interior point.

getAdjacentIndices

$block getAdjacentIndices ?-linear? index

This action returns the indices that are directly connected to the specified index.

Parameters

-linearIf this optional flag is specified, the results will be a list of integer linear indices regardless of the input form.  This is the default option and is present to maintain consistency with the form of the command used for pw::BlockStructured and pw::BlockExtruded objects.
indexThis required parameter is the integer linear index of the grid point with the range [1, number of points].

Returns

This action returns a list of integer indices representing the adjacent coordinates.

getCellsUsingIndex

$block getCellsUsingIndex ?-linear? index

This action returns the indices that are directly connected to the specified index.

Parameters

-linearIf this optional flag is specified, the results will be a list of integer linear indices regardless of the input form.  This is the default option and is present to maintain consistency with the form of the command used for pw::BlockStructured and pw::BlockExtruded objects.
indexThis required parameter is the integer linear index of the grid point with the range [1, number of points].

Returns

This action returns a list of cell entries using the specified point.  Each cell entry is a list of integer point indices comprising the cell.

getPosition

$block getPosition ?-grid? index

This action gets the position in the defining space of the block at the given index.

Parameters

-gridThis optional flag is a notification to get the position at a grid point.  This is the default.
indexThis required parameter is the integer linear index to get the position at with the range [1, number of points].

Returns

This action returns a point giving the position on the block (may be in the form “u v dbentity”).

Information

Block points are not currently db-constrained, so this command returns only XYZ coordinates.

Even though it is not needed, the -grid switch is included here to be consistent with the other grid entity getPosition methods.  The following calls are equivalent:

$blk1 getPosition -grid 5
$blk1 getPosition 5

See Also

pw::BlockStructured.getPosition pw::BlockExtruded.getPosition pw::Connector.getPosition pw::Domain.getPosition pw::DomainStructured.getPosition

getXYZ

$block getXYZ ?-grid? index

This action gets the position of the block in model space at the given index.

Parameters

-gridThis optional flag is notification to get the position at a grid point.  This is the default.
indexThis required parameter is the integer linear index to get the position at with the range [1, number of points].

Returns

This action returns an XYZ vector.

Information

Even though it is not needed, the -grid switch is included here to be consistent with the other grid entity getXYZ methods.  The following calls are equivalent:

$blk1 getXYZ -grid 5
$blk1 getXYZ 5

See Also

pw::BlockStructured.getXYZ pw::BlockExtruded.getXYZ pw::Connector.getXYZ pw::Domain.getXYZ pw::DomainStructured.getXYZ

getCellCount

$block getCellCount

This action gets the number of cells in this block.

Parameters

There are no parameters.

Returns

This action returns the integer number of cells.

getCell

$block getCell index

This action gets the indices of the given cell.

Parameters

indexThis required parameter is the integer index of the target cell in the range [1, number of cells].

Returns

This action returns an integer list of point indices.

getCellAverageEdgeLength

$block getCellAverageEdgeLength index

This action gets the average edge length of the given cell.

Parameters

indexThis required parameter is the integer index of the target cell in the range [1, number of cells].

Returns

This action returns a float.

getCellCentroid

$block getCellCentroid index

This action gets the centroid of the given cell.

Parameters

indexThis required parameter is the integer index of the target cell in the range [1, number of cells].

Returns

This action returns an XYZ vector.

getCellVolume

$block getCellVolume index

This action gets the volume of the given cell.

Parameters

indexThis required parameter is the integer index of the target cell in the range [1, number of cells].

Returns

This action returns a float.

getFaceCount

$block getFaceCount

This action gets the number of faces in this block.

Parameters

There are no parameters.

Returns

This action returns the integer number of faces.

getFace

$block getFace index

This action gets the face at the given index.

Parameters

indexThis required parameter is the integer index of the target face in the range [1, number of faces].

Returns

This action returns a pw::Face object.

getFaces

$block getFaces

This action gets the face list.

Parameters

This action has no parameters.

Returns

This action returns a pw::Face object list.

addFace

$block addFace face

This action adds a face to the block.

Parameters

faceThis required parameter is the pw::Face object to add.

Returns

This action returns nothing.

removeLastFace

$block removeLastFace

This action removes the last face added to this block.

Parameters

There are no parameters.

Returns

This action returns nothing.

isValid

$block isValid

This action checks to see if the block has a valid face definition.

Parameters

There are no parameters.

Returns

This action returns a boolean.

Overset Data Actions

clearOversetData

$block clearOversetData

This action clears overset grid assembly data from the block.

Parameters

Returns

This action returns nothing.

getIblank

$block getIblank ?-path path? index

This action returns the IBLANK data for a block.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.
indexthe block index at which to return the iblank value.  The index will be a cell index if the iblank type is cell-based, or a point index if the type is point-based.

Returns

This action returns the iblank value at the given index.

Example

Code

$block ?-path path? getIblank {1 1 1}

getIblankType

$block getIblankType ?-path path?

This action returns the IBLANK type for a block.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.

Returns

This action returns the IBLANK type.

Example

Code

$block getIblankType

getOversetIndexList

$block getOversetIndexList ?-path path? ?-fringe? ?-hole? ?-orphan?

This action returns the list of original block indices for a given overset object type.  If no parameters are given, the block indices for all non-field overset objects are returned.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.
-fringeThis optional parameter indicates that the original block indices for fringe objects should be included in the result list.
-holeThis optional parameter indicates that the original block indices for hole objects should be included in the result list.
-orphanThis optional parameter indicates that the original block indices for orphan objects should be included in the result list.

Returns

This action returns a list of index for the given overset object types.  The elements are the original block cell or point indices from the most recently imported overset grid assembly.

Example

Code

$block getOversetIndexList -fringe

getOversetDataDimensions

$block getOversetDataDimensions ?-path path?

This action returns the original block point or cell dimensions used by the most recent import of overset assembly data.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.

Returns

This action returns an index representing the maximum IJK dimensions for which overset data is stored for this block.

Example

Code

$block getOversetDataDimensions

isOversetDataUpToDate

$block isOversetDataUpToDate ?-path path?

This action returns whether the overset data for a block is up to date.  Overset data is considered out of date if it either does not exist or if the block or any of the donor blocks have been modified since the most recent import after overset grid assembly.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.

Returns

This action returns a boolean, true if there is overset data and it is up to date with respect to the block.

Example

Code

$block isOversetDataUpToDate

getHighOrderSolverAttribute

$block getHighOrderSolverAttribute att_name

This action gets the named high order solver attribute.

Parameters

att_nameThis required parameter is the name string of the attribute to get.

Returns

This action returns the actual or default value of the named attribute.

See Also

setHighOrderSolverAttribute

setHighOrderSolverAttribute

$block setHighOrderSolverAttribute att_name att_value

This action sets the named high order solver attribute.

Parameters

att_nameThis required parameter is the string name of the attribute to set.
att_valueThis required parameter is the new attribute value, a string, integer or float depending on the attribute.

Returns

This action returns nothing.

See Also

getHighOrderSolverAttribute

High Order Solver Attributes

ConvergenceCostThreshold

$block get/setHighOrderSolverAttribute ConvergenceCostThreshold value

The threshold value for the minimum curving cost smoothing function.  If all mesh elements meet or exceed this value, the smoothing routine is stopped prior to reaching the specified number of smoothing passes.

Type

A float in the range [0.0, 1.0].

Default

The default for this attribute is set using the current value of ConvergenceCostThreshold (Default).

See Also

ConvergenceCostThreshold (Default)

DeviationThreshold

$block get/setHighOrderSolverAttribute DeviationThreshold value

The maximum threshold for deviation.  This is used both for surface deviation and for deviation between adjacent elements of different orders.

Type

A float in the range (0.0, 1.0].

Default

The default for this attribute is set using the current value of DeviationThreshold (Default).

See Also

DeviationThreshold (Default)

FreezeSurfaceNodes

$block get/setHighOrderSolverAttribute FreezeSurfaceNodes value

Controls which linear and inserted and projected, high-order surface nodes can be moved during smoothing.  The inserted, high-order surface nodes are always projected to their surfaces as needed.

Type

A string one of None, Linear, or All.

where,

NoneAll surface points are frozen.
LinearFreezes the linear surface nodes.  The inserted and projected, high-order surface nodes can be moved.
AllFreezes both the linear and inserted and projected, high-order surface nodes.

Default

The default for this attribute is set using the current value of FreezeSurfaceNodes (Default).

See Also

FreezeSurfaceNodes (Default)

PolynomialDegreeMin

$block get/setHighOrderSolverAttribute PolynomialDegreeMin value

Specifies a minimum polynomial degree for mixed order mesh elevation.  This value must be less than or equal to PolynomialDegreeMax.

Type

A string one of Q1, Q2, Q3, or Q4.

Default

The default for this attribute is set using the current value of PolynomialDegreeMin (Default).

See Also

PolynomialDegreeMin (Default)

PolynomialDegreeMax

$block get/setHighOrderSolverAttribute PolynomialDegreeMax value

Specifies the polynomial degree for constant order mesh elevation or the maximum polynomial degree for mixed order mesh elevation.  This value must be greater than or equal to PolynomialDegreeMin.

Type

A string one of Q2, Q3, or Q4.

Default

The default for this attribute is set using the current value of PolynomialDegreeMax (Default).

See Also

PolynomialDegreeMax (Default)

StepSizeRelaxationFactor

$block get/setHighOrderSolverAttribute StepSizeRelaxationFactor value

The step size factor used when smoothing the high-order nodes.

Type

A float in the range [0.0, 0.5].

Default

The default for this attribute is set using the current value of StepSizeRelaxationFactor (Default).

See Also

StepSizeRelaxationFactor (Default)

Static Defaults

ConvergenceCostThreshold (Default)

pw::Block get/setDefault ConvergenceCostThreshold value

The default minimum curving cost threshold value assigned to a block when it is created.

Type

A float in the range [0.0, 1.0].

Default

The default value is 0.8.

See Also

ConvergenceCostThreshold

DeviationThreshold (Default)

pw::Block get/setDefault DeviationThreshold value

The default deviation threshold value assigned to a block when it is created.

Type

A float in the range (0.0, 1.0].

Default

The default value is 0.1.

See Also

DeviationThreshold

FreezeSurfaceNodes (Default)

pw::Block get/setDefault FreezeSurfaceNodes value

The default freeze method value assigned to a block when it is created.

Type

A string one of None, Linear, or All.

where,

NoneAll surface points are frozen.
LinearFreezes the linear surface nodes.  The inserted and projected, high-order surface nodes can be moved.
AllFreezes both the linear and inserted and projected, high-order surface nodes.

Default

The default value is Linear.

See Also

FreezeSurfaceNodes

PolynomialDegreeMin (Default)

pw::Block get/setDefault PolynomialDegreeMin value

The default minimum polynomial degree value assigned to a block when it is created.  This value must be less than or equal to PolynomialDegreeMax (Default).

Type

A string one of Q1, Q2, Q3, or Q4.

Default

The default value is Q2.

See Also

PolynomialDegreeMin

PolynomialDegreeMax (Default)

pw::Block get/setDefault PolynomialDegreeMax value

The default max polynomial degree value assigned to a block when it is created.  This value must be greater than or equal to PolynomialDegreeMin (Default).

Type

A string one of Q2, Q3, or Q4.

Default

The default value is Q2.

See Also

PolynomialDegreeMax

StepSizeRelaxationFactor (Default)

pw::Block get/setDefault StepSizeRelaxationFactor value

The default step size factor value assigned to a block when it is created.

Type

A float in the range [0.0, 0.5].

Default

The default value is 0.05.

See Also

StepSizeRelaxationFactor

getOversetData

$block getOversetData ?-path path? <Volume | VertexList | Donor | DonorCandidateList> index

This action returns overset data of the given type at the specified index.  If the overset object type at the given index is not valid for the requested type, then an error is returned.

Parameters

-pathThis optional parameter specifies the framework_path to the specific instance of the block.  The default value is the active framework.
typeThis required parameters is a string with options < Volume | VertexList | Donor | DonorCandidateList >.
indexthe block index at which to return the overset object data.  The index must be within the original, as-assembled dimensions of the block, which are returned by getOversetDataDimensions

Returns

This action returns a single value or a list of string, float, integer and/or list of other values representing the overset data at the specified index.

See the description of the structure of the return values in the corresponding type description.

See Also

getOversetDataDimensions

Example

Code

$block getOversetData Volume $index

Overset Data Types

Volume

$block getOversetData ?-path path? Volume index

Return the volume for an overset data object.

Type

A float, valid for fringe, hole and orphan objects.

See Also

getOversetData

VertexList

$block getOversetData ?-path path? VertexList index

Return the list of vertices for an overset data object.

Type

A point for point-based data, or a list of points for cell-based data defining the cell stencil, valid for fringe, hole and orphan objects.

See Also

getOversetData

Donor

$block getOversetData ?-path path? Donor index

Return the donor information for an overset fringe object.

Type

Donor information is a list of

  • donor pw::Block
  • the donor cell index
  • a float representing the donor cell volume
  • donor cell vertex point (point-based data) or list of point (cell-based data)
  • an integer representing the assembler-dependent donor cell status
  • a float representing the assembler-dependent donor cell quality

Donor information is valid only for fringe objects.

DonorCandidateList

$block getOversetData DonorCandidateList index

Return the donor candidate information for an overset fringe or orphan object.

Type

Donor candidate information is a list of donor information.  See Donor for the description of a donor in list form.  Donor information is valid for fringe and orphan objects.

A face is part of a block boundary, consisting of oriented, edge-connected pw::Domain objects.
pw::Block getAdjacentBlocks ?-all? blocks
This action finds blocks adjacent to a starting list of blocks.
pw::Block getBlocksFromDomains domains
This action returns a list of blocks that use the given domains.
pw::Block setSortOrder blocks
This action sets the user specified sort order of blocks.
$block delete ?-force? ?-domains? ?-connectors?
This action deletes this block.
$block initialize
This action initializes the interior points of this block.
$block getInteriorState
This action gets the interior state of this block.
$block getDimensions
This action gets the dimension of this block.
$block getPoint ?-constrained constrainedVar? index
This action gets the position of a block grid point.
$block setPoint index point
This action sets the position of a block interior grid point.
$block isInteriorIndex index
This action checks to see if an index corresponds to a point in the interior of the block.
$block getAdjacentIndices ?-linear? index
This action returns the indices that are directly connected to the specified index.
$block getCellsUsingIndex ?-linear? index
This action returns the indices that are directly connected to the specified index.
$block getPosition ?-grid? index
This action gets the position in the defining space of the block at the given index.
$block getXYZ ?-grid? index
This action gets the position of the block in model space at the given index.
$block getCellCount
This action gets the number of cells in this block.
$block getCell index
This action gets the indices of the given cell.
$block getCellAverageEdgeLength index
This action gets the average edge length of the given cell.
$block getCellCentroid index
This action gets the centroid of the given cell.
$block getCellVolume index
This action gets the volume of the given cell.
$block getFaceCount
This action gets the number of faces in this block.
$block getFace index
This action gets the face at the given index.
$block getFaces
This action gets the face list.
$block addFace face
This action adds a face to the block.
$block removeLastFace
This action removes the last face added to this block.
$block isValid
This action checks to see if the block has a valid face definition.
$block clearOversetData
This action clears overset grid assembly data from the block.
$block getIblank ?-path path? index
This action returns the IBLANK data for a block.
$block getIblankType ?-path path?
This action returns the IBLANK type for a block.
$block getOversetIndexList ?-path path? ?-fringe? ?-hole? ?-orphan?
This action returns the list of original block indices for a given overset object type.
$block getOversetDataDimensions ?-path path?
This action returns the original block point or cell dimensions used by the most recent import of overset assembly data.
$block isOversetDataUpToDate ?-path path?
This action returns whether the overset data for a block is up to date.
$block getHighOrderSolverAttribute att_name
This action gets the named high order solver attribute.
$block setHighOrderSolverAttribute att_name att_value
This action sets the named high order solver attribute.
$block get/setHighOrderSolverAttribute ConvergenceCostThreshold value
The threshold value for the minimum curving cost smoothing function.
$block get/setHighOrderSolverAttribute DeviationThreshold value
The maximum threshold for deviation.
$block get/setHighOrderSolverAttribute FreezeSurfaceNodes value
Controls which linear and inserted and projected, high-order surface nodes can be moved during smoothing.
$block get/setHighOrderSolverAttribute PolynomialDegreeMin value
Specifies a minimum polynomial degree for mixed order mesh elevation.
$block get/setHighOrderSolverAttribute PolynomialDegreeMax value
Specifies the polynomial degree for constant order mesh elevation or the maximum polynomial degree for mixed order mesh elevation.
$block get/setHighOrderSolverAttribute StepSizeRelaxationFactor value
The step size factor used when smoothing the high-order nodes.
pw::Block get/setDefault ConvergenceCostThreshold value
The default minimum curving cost threshold value assigned to a block when it is created.
pw::Block get/setDefault DeviationThreshold value
The default deviation threshold value assigned to a block when it is created.
pw::Block get/setDefault FreezeSurfaceNodes value
The default freeze method value assigned to a block when it is created.
pw::Block get/setDefault PolynomialDegreeMin value
The default minimum polynomial degree value assigned to a block when it is created.
pw::Block get/setDefault PolynomialDegreeMax value
The default max polynomial degree value assigned to a block when it is created.
pw::Block get/setDefault StepSizeRelaxationFactor value
The default step size factor value assigned to a block when it is created.
$block getOversetData ?-path path? <Volume | VertexList | Donor | DonorCandidateList> index
This action returns overset data of the given type at the specified index.
$block getOversetData ?-path path? Volume index
Return the volume for an overset data object.
$block getOversetData ?-path path? VertexList index
Return the list of vertices for an overset data object.
$block getOversetData ?-path path? Donor index
Return the donor information for an overset fringe object.
$block getOversetData DonorCandidateList index
Return the donor candidate information for an overset fringe or orphan object.
Base type for all glyph types
Entity type
Base type for all grid entities.
A block is a volume grid bounded by one or more pw::Faces.
A domain is a computationally two-dimensional grid entity, bounded by one or more pw::Edges.
pw::Entity sort entities
This action sorts the given entities.
pw::Domain setSortOrder domains
This action sets the user specified sort order of domains.
pw::Entity delete entities
This action deletes the given entities.
A string is an array of characters.
An integer is a whole number.
A point is a position either in model space or database parameter space.
A structured block is a computationally orthogonal volume grid, bounded by exactly six pw::FaceStructured faces, any of which can be degenerate in one (line) or zero (pole) dimensions.
An extruded block is a step-wise constructed prismatic volume originating from one or more pw::Face objects.
$block getPosition ?-grid? < index | ijk_index >
This action gets the position in the defining space of the block at the given index.
$block getPosition ?-grid? < index | ijk_index >
This action gets the position in the defining space of the block at the given index.
$con getPosition ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value
This action gets a position on a connector in the defining space of the connector.
$dom getPosition ?-grid? value
This action gets a position in the defining space of the domain.
$dom getPosition ?-grid? value
This action gets the position in the defining space of the domain at the given index.
A vector is a list of float values.
$block getXYZ ?-grid? < index | ijk_index >
This action gets the position of the block in model space at the given index.
$block getXYZ ?-grid? < index | ijk_index >
This action gets the position of the block in model space at the given index.
$con getXYZ ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value
This action gets the model space position on a connector.
$dom getXYZ ?-grid? value
This action gets a position of the domain in model space.
$dom getXYZ ?-grid? value
This action gets the position of the domain in model space at the given index.
A float is a fractional number.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A framework_path is a reference to a specific framework.
An index is a list of integer values.
Close