pw:: Block

pw::Block getAdjacentBlocks ?-all? blocks

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

Parameters

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.

pw::Block getBlocksFromDomains domains

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

Parameters

Returns

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

pw::Block setSortOrder blocks

This action sets the user specified sort order of blocks.

Parameters

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

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

This action deletes this block.

Parameters

Returns

This action returns nothing.

See Also

pw::Entity.delete

$block initialize

This action initializes the interior points of this block.

Parameters

There are no parameters.

Returns

This action returns nothing.

$block getInteriorState

This action gets the interior state of this block.

Parameters

There are no parameters.

Returns

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

$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].

$block getPoint ?-constrained constrainedVar? index

This action gets the position of a block grid point.

Parameters

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.

$block setPoint index point

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

Parameters

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.

$block isInteriorIndex index

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

Parameters

Returns

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

$block getAdjacentIndices ?-linear? index

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

Parameters

Returns

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

$block getCellsUsingIndex ?-linear? index

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

Parameters

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.

$block getPosition ?-grid? index

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

Parameters

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

$block getXYZ ?-grid? index

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

Parameters

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

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

$block getCell index

This action gets the indices of the given cell.

Parameters

Returns

This action returns an integer list of point indices.

$block getCellAverageEdgeLength index

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

Parameters

Returns

This action returns a float.

$block getCellCentroid index

This action gets the centroid of the given cell.

Parameters

Returns

This action returns an XYZ vector.

$block getCellVolume index

This action gets the volume of the given cell.

Parameters

Returns

This action returns a float.

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

$block getFace index

This action gets the face at the given index.

Parameters

Returns

This action returns a pw::Face object.

$block addFace face

This action adds a face to the block.

Parameters

Returns

This action returns nothing.

$block removeLastFace

This action removes the last face added to this block.

Parameters

There are no parameters.

Returns

This action returns nothing.

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

$block clearOversetData

This action clears overset grid assembly data from the block.

Parameters

Returns

This action returns nothing.

$block getIblank ?-path path? index

This action returns the IBLANK data for a block.

Parameters

Returns

This action returns the iblank value at the given index.

Example

Code

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

$block getIblankType ?-path path?

This action returns the IBLANK type for a block.

Parameters

Returns

This action returns the IBLANK type.

Example

Code

$block getIblankType

$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

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

$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

Returns

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

Example

Code

$block getOversetDataDimensions

$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

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

$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

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.

Example

Code

$block getOversetData Volume $index

$block getOversetData ?-path path? Volume index

Return the volume for an overset data object.

Type

Overset object volume is a float and is valid for fringe, hole and orphan objects.

$block getOversetData ?-path path? VertexList index

Return the list of vertices for an overset data object.

Type

For point-based data, this is a single point.  For cell-based data, this is a list of point defining the cell stencil.  Overset object vertex list is valid for fringe, hole and orphan objects.

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

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