Glyph2 Version 2.18.0 |
pw:: BlockBlock type Derives Frompw::Object pw::Entity pw::GridEntity Summary
getAdjacentBlocks
This action finds blocks adjacent to a starting list of blocks. Parameters
ReturnsThis action returns the list of adjacent pw::Block objects found. InformationThe returned list will not include any blocks specified in the original blocks list. getBlocksFromDomains
This action returns a list of blocks that use the given domains. Parameters
ReturnsThis action returns a list of pw::Block objects. setSortOrder
This action sets the user specified sort order of blocks. Parameters
ReturnsThis action returns nothing. InformationAny 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 Alsodelete
This action deletes this block. Parameters
ReturnsThis action returns nothing. See AlsogetInteriorState
This action gets the interior state of this block. ParametersThere are no parameters. ReturnsThis action returns a string; < Empty | Incomplete | Initialized | Locked | Refined >. getDimensions
This action gets the dimension of this block. ParametersThere are no parameters. ReturnsThis action returns the block dimensions as a three-element integer list. Unstructured blocks have second and third dimensions of 1: [N 1 1]. getPoint
This action gets the position of a block grid point. Parameters
ReturnsThis action returns a point giving the grid point position (may be in the form “u v dbentity”). InformationBlock points are not currently db-constrained, so this command returns only XYZ coordinates. setPoint
This action sets the position of a block interior grid point. Parameters
ReturnsThis action returns nothing. InformationBlock points are not currently db-constrained, so any database information in the point argument is converted to pure XYZ data before being stored. isInteriorIndex
This action checks to see if an index corresponds to a point in the interior of the block. Parameters
ReturnsThis action returns true if the index refers to an interior point. getAdjacentIndices
This action returns the indices that are directly connected to the specified index. Parameters
ReturnsThis action returns a list of integer indices representing the adjacent coordinates. getCellsUsingIndex
This action returns the indices that are directly connected to the specified index. Parameters
ReturnsThis 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
This action gets the position in the defining space of the block at the given index. Parameters
ReturnsThis action returns a point giving the position on the block (may be in the form “u v dbentity”). InformationBlock 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 See Alsopw::BlockStructured.getPosition pw::BlockExtruded.getPosition pw::Connector.getPosition pw::Domain.getPosition pw::DomainStructured.getPosition getXYZ
This action gets the position of the block in model space at the given index. Parameters
ReturnsThis action returns an XYZ vector. InformationEven 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 See Alsopw::BlockStructured.getXYZ pw::BlockExtruded.getXYZ pw::Connector.getXYZ pw::Domain.getXYZ pw::DomainStructured.getXYZ getCellCount
This action gets the number of cells in this block. ParametersThere are no parameters. ReturnsThis action returns the integer number of cells. getFaceCount
This action gets the number of faces in this block. ParametersThere are no parameters. ReturnsThis action returns the integer number of faces. addFace
This action adds a face to the block. Parameters
ReturnsThis action returns nothing. isValid
This action checks to see if the block has a valid face definition. ParametersThere are no parameters. ReturnsThis action returns a boolean. getIblank
This action returns the IBLANK data for a block. Parameters
ReturnsThis action returns the iblank value at the given index. ExampleCode $block ?-path path? getIblank {1 1 1} getIblankType
This action returns the IBLANK type for a block. Parameters
ReturnsThis action returns the IBLANK type. ExampleCode $block getIblankType getOversetIndexList
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
ReturnsThis 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. ExampleCode $block getOversetIndexList -fringe getOversetDataDimensions
This action returns the original block point or cell dimensions used by the most recent import of overset assembly data. Parameters
ReturnsThis action returns an index representing the maximum IJK dimensions for which overset data is stored for this block. ExampleCode $block getOversetDataDimensions isOversetDataUpToDate
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
ReturnsThis action returns a boolean, true if there is overset data and it is up to date with respect to the block. ExampleCode $block isOversetDataUpToDate getOversetData
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
ReturnsThis 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. ExampleCode $block getOversetData Volume $index Volume
Return the volume for an overset data object. TypeOverset object volume is a float and is valid for fringe, hole and orphan objects. VertexList
Return the list of vertices for an overset data object. TypeFor 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. Donor
Return the donor information for an overset fringe object. TypeDonor information is a list of
Donor information is valid only for fringe objects. DonorCandidateList
Return the donor candidate information for an overset fringe or orphan object. TypeDonor 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. |
This action finds blocks adjacent to a starting list of blocks.
pw::Block getAdjacentBlocks ?-all? blocks
This action returns a list of blocks that use the given domains.
pw::Block getBlocksFromDomains domains
This action sets the user specified sort order of blocks.
pw::Block setSortOrder blocks
This action deletes this block.
$block delete ?-force? ?-domains? ?-connectors?
This action initializes the interior points of this block.
$block initialize
This action gets the interior state of this block.
$block getInteriorState
This action gets the dimension of this block.
$block getDimensions
This action gets the position of a block grid point.
$block getPoint ?-constrained constrainedVar? index
This action sets the position of a block interior grid point.
$block setPoint index point
This action checks to see if an index corresponds to a point in the interior of the block.
$block isInteriorIndex index
This action returns the indices that are directly connected to the specified index.
$block getAdjacentIndices ?-linear? index
This action returns the indices that are directly connected to the specified index.
$block getCellsUsingIndex ?-linear? index
This action gets the position in the defining space of the block at the given index.
$block getPosition ?-grid? index
This action gets the position of the block in model space at the given index.
$block getXYZ ?-grid? index
This action gets the number of cells in this block.
$block getCellCount
This action gets the indices of the given cell.
$block getCell index
This action gets the average edge length of the given cell.
$block getCellAverageEdgeLength index
This action gets the centroid of the given cell.
$block getCellCentroid index
This action gets the volume of the given cell.
$block getCellVolume index
This action gets the number of faces in this block.
$block getFaceCount
This action gets the face at the given index.
$block getFace index
This action adds a face to the block.
$block addFace face
This action removes the last face added to this block.
$block removeLastFace
This action checks to see if the block has a valid face definition.
$block isValid
This action clears overset grid assembly data from the block.
$block clearOversetData
This action returns the IBLANK data for a block.
$block getIblank ?-path path? index
This action returns the IBLANK type for a block.
$block getIblankType ?-path path?
This action returns the list of original block indices for a given overset object type.
$block getOversetIndexList ?-path path? ?-fringe? ?-hole? ?-orphan?
This action returns the original block point or cell dimensions used by the most recent import of overset assembly data.
$block getOversetDataDimensions ?-path path?
This action returns whether the overset data for a block is up to date.
$block isOversetDataUpToDate ?-path path?
This action returns overset data of the given type at the specified index.
$block getOversetData ?-path path? <Volume | VertexList | Donor | DonorCandidateList> index
Return the volume for an overset data object.
$block getOversetData ?-path path? Volume index
Return the list of vertices for an overset data object.
$block getOversetData ?-path path? VertexList index
Return the donor information for an overset fringe object.
$block getOversetData ?-path path? Donor index
Return the donor candidate information for an overset fringe or orphan object.
$block getOversetData DonorCandidateList index
This action sorts the given entities.
pw::Entity sort entities
This action sets the user specified sort order of domains.
pw::Domain setSortOrder domains
This action deletes the given entities.
pw::Entity delete entities
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.
$block getPosition ?-grid? < index | ijk_index >
This action gets a position on a connector in the defining space of the connector.
$con getPosition ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? 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.
$dom getPosition ?-grid? value
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.
$block getXYZ ?-grid? < index | ijk_index >
This action gets the model space position on a connector.
$con getXYZ ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? 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.
$dom getXYZ ?-grid? value