A block is a volume grid bounded by one or more pw::Faces.
pw::Object pw::Entity pw::GridEntity
| pw:: | A block is a volume grid bounded by one or more pw::Faces. |
| Static Actions | |
| getAdjacentBlocks | This action finds blocks adjacent to a starting list of blocks. |
| getBlocksFromDomains | This action returns a list of blocks that use the given domains. |
| setSortOrder | This action sets the user specified sort order of blocks. |
| Instance Actions | |
| delete | This action deletes this block. |
| initialize | This action initializes the interior points of this block. |
| getInteriorState | This action gets the interior state of this block. |
| getDimensions | This action gets the dimension of this block. |
| getPoint | This action gets the position of a block grid point. |
| setPoint | This action sets the position of a block interior grid point. |
| isInteriorIndex | This action checks to see if an index corresponds to a point in the interior of the block. |
| getAdjacentIndices | This action returns the indices that are directly connected to the specified index. |
| getCellsUsingIndex | This action returns the indices that are directly connected to the specified index. |
| getPosition | This action gets the position in the defining space of the block at the given index. |
| getXYZ | This action gets the position of the block in model space at the given index. |
| getCellCount | This action gets the number of cells in this block. |
| getCell | This action gets the indices of the given cell. |
| getCellAverageEdgeLength | This action gets the average edge length of the given cell. |
| getCellCentroid | This action gets the centroid of the given cell. |
| getCellVolume | This action gets the volume of the given cell. |
| getFaceCount | This action gets the number of faces in this block. |
| getFace | This action gets the face at the given index. |
| getFaces | This action gets the face list. |
| addFace | This action adds a face to the block. |
| removeLastFace | This action removes the last face added to this block. |
| isValid | This action checks to see if the block has a valid face definition. |
| Overset Data Actions | |
| clearOversetData | This action clears overset grid assembly data from the block. |
| getIblank | This action returns the IBLANK data for a block. |
| getIblankType | This action returns the IBLANK type for a block. |
| getOversetIndexList | This action returns the list of original block indices for a given overset object type. |
| getOversetDataDimensions | This action returns the original block point or cell dimensions used by the most recent import of overset assembly data. |
| isOversetDataUpToDate | This action returns whether the overset data for a block is up to date. |
| getHighOrderSolverAttribute | This action gets the named high order solver attribute. |
| setHighOrderSolverAttribute | This action sets the named high order solver attribute. |
| High Order Solver Attributes | |
| ConvergenceCostThreshold | The threshold value for the minimum curving cost smoothing function. |
| DeviationThreshold | The maximum threshold for deviation. |
| FreezeSurfaceNodes | Controls which linear and inserted and projected, high-order surface nodes can be moved during smoothing. |
| PolynomialDegreeMin | Specifies a minimum polynomial degree for mixed order mesh elevation. |
| PolynomialDegreeMax | Specifies the polynomial degree for constant order mesh elevation or the maximum polynomial degree for mixed order mesh elevation. |
| StepSizeRelaxationFactor | The 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. |
| getOversetData | This action returns overset data of the given type at the specified index. |
| Overset Data Types | |
| Volume | Return the volume for an overset data object. |
| VertexList | Return the list of vertices for an overset data object. |
| Donor | Return the donor information for an overset fringe object. |
| DonorCandidateList | Return the donor candidate information for an overset fringe or orphan object. |
pw::Block getAdjacentBlocks ?-all? blocks
This action finds blocks adjacent to a starting list of blocks.
| -all | This optional flag is a notification to repeat the search on the adjacent blocks found until there are no more adjacent blocks. |
| blocks | This required parameter is a list of starting pw::Block objects. |
This action returns the list of adjacent pw::Block objects found.
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.
| domains | This required parameter is a list of pw::Domain objects. |
This action returns a list of pw::Block objects.
pw::Block setSortOrder blocks
This action sets the user specified sort order of blocks.
| blocks | This required parameter is a list of pw::Block objects and the order they should appear in for sorting. |
This action returns nothing.
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.
$block delete ?-force? ?-domains? ?-connectors?
This action deletes this block.
| -force | This optional flag is a notification to delete the entity as well as higher level entities that depend on this entity. |
| -domains | This optional flag is a notification to delete the block domains if they will be left orphaned. |
| -connectors | This 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. |
This action returns nothing.
$block getInteriorState
This action gets the interior state of this block.
There are no parameters.
This action returns a string with options < Empty | Incomplete | Initialized | Locked | Refined >.
$block getDimensions
This action gets the dimension of this block.
There are no parameters.
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.
| index | This required parameter is the integer linear index of the grid point to get with the range [1, number of points]. |
| -constrained constrainedVar | This 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. |
This action returns a point giving the grid point position (may be in the form “u v dbentity”).
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.
| index | This 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. |
| point | This required parameter is the new point value of the grid point. |
This action returns nothing.
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.
| index | This required parameter is the integer linear index of the grid point to check with the range [1, number of points]. |
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.
| -linear | If 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. |
| index | This required parameter is the integer linear index of the grid point with the range [1, number of points]. |
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.
| -linear | If 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. |
| index | This required parameter is the integer linear index of the grid point with the range [1, number of points]. |
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.
| -grid | This optional flag is a notification to get the position at a grid point. This is the default. |
| index | This required parameter is the integer linear index to get the position at with the range [1, number of points]. |
This action returns a point giving the position on the block (may be in the form “u v dbentity”).
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
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.
| -grid | This optional flag is notification to get the position at a grid point. This is the default. |
| index | This required parameter is the integer linear index to get the position at with the range [1, number of points]. |
This action returns an XYZ vector.
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
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.
There are no parameters.
This action returns the integer number of cells.
$block getFaceCount
This action gets the number of faces in this block.
There are no parameters.
This action returns the integer number of faces.
$block getFaces
This action gets the face list.
This action has no parameters.
This action returns a pw::Face object list.
$block addFace face
This action adds a face to the block.
| face | This required parameter is the pw::Face object to add. |
This action returns nothing.
$block isValid
This action checks to see if the block has a valid face definition.
There are no parameters.
This action returns a boolean.
$block getIblank ?-path path? index
This action returns the IBLANK data for a block.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
| index | the 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. |
This action returns the iblank value at the given index.
Code
$block ?-path path? getIblank {1 1 1}
$block getIblankType ?-path path?
This action returns the IBLANK type for a block.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
This action returns the IBLANK type.
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.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
| -fringe | This optional parameter indicates that the original block indices for fringe objects should be included in the result list. |
| -hole | This optional parameter indicates that the original block indices for hole objects should be included in the result list. |
| -orphan | This optional parameter indicates that the original block indices for orphan objects should be included in the result list. |
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.
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.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
This action returns an index representing the maximum IJK dimensions for which overset data is stored for this block.
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.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
This action returns a boolean, true if there is overset data and it is up to date with respect to the block.
Code
$block isOversetDataUpToDate
$block getHighOrderSolverAttribute att_name
This action gets the named high order solver attribute.
| att_name | This required parameter is the name string of the attribute to get. |
This action returns the actual or default value of the named attribute.
$block setHighOrderSolverAttribute att_name att_value
This action sets the named high order solver attribute.
| att_name | This required parameter is the string name of the attribute to set. |
| att_value | This required parameter is the new attribute value, a string, integer or float depending on the attribute. |
This action returns nothing.
$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.
A float in the range [0.0, 1.0].
The default for this attribute is set using the current value of ConvergenceCostThreshold (Default).
$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.
A float in the range (0.0, 1.0].
The default for this attribute is set using the current value of DeviationThreshold (Default).
$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.
A string one of None, Linear, or All.
where,
| None | All surface points are frozen. |
| Linear | Freezes the linear surface nodes. The inserted and projected, high-order surface nodes can be moved. |
| All | Freezes both the linear and inserted and projected, high-order surface nodes. |
The default for this attribute is set using the current value of FreezeSurfaceNodes (Default).
$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.
A string one of Q1, Q2, Q3, or Q4.
The default for this attribute is set using the current value of PolynomialDegreeMin (Default).
$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.
A string one of Q2, Q3, or Q4.
The default for this attribute is set using the current value of PolynomialDegreeMax (Default).
$block get/setHighOrderSolverAttribute StepSizeRelaxationFactor value
The step size factor used when smoothing the high-order nodes.
A float in the range [0.0, 0.5].
The default for this attribute is set using the current value of StepSizeRelaxationFactor (Default).
pw::Block get/setDefault ConvergenceCostThreshold value
The default minimum curving cost threshold value assigned to a block when it is created.
A float in the range [0.0, 1.0].
The default value is 0.8.
pw::Block get/setDefault DeviationThreshold value
The default deviation threshold value assigned to a block when it is created.
A float in the range (0.0, 1.0].
The default value is 0.1.
pw::Block get/setDefault FreezeSurfaceNodes value
The default freeze method value assigned to a block when it is created.
A string one of None, Linear, or All.
where,
| None | All surface points are frozen. |
| Linear | Freezes the linear surface nodes. The inserted and projected, high-order surface nodes can be moved. |
| All | Freezes both the linear and inserted and projected, high-order surface nodes. |
The default value is Linear.
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).
A string one of Q1, Q2, Q3, or Q4.
The default value is Q2.
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).
A string one of Q2, Q3, or Q4.
The default value is Q2.
pw::Block get/setDefault StepSizeRelaxationFactor value
The default step size factor value assigned to a block when it is created.
A float in the range [0.0, 0.5].
The default value is 0.05.
$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.
| -path | This optional parameter specifies the framework_path to the specific instance of the block. The default value is the active framework. |
| type | This required parameters is a string with options < Volume | VertexList | Donor | DonorCandidateList >. |
| index | the 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 |
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.
Code
$block getOversetData Volume $index
$block getOversetData ?-path path? Volume index
Return the volume for an overset data object.
A float, valid for fringe, hole and orphan objects.
$block getOversetData ?-path path? Donor index
Return the donor information for an overset fringe object.
Donor information is a list of
Donor information is valid only for fringe objects.
$block getOversetData DonorCandidateList index
Return the donor candidate information for an overset fringe or orphan object.
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.
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 gets the face list.
$block getFaces
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 gets the named high order solver attribute.
$block getHighOrderSolverAttribute att_name
This action sets the named high order solver attribute.
$block setHighOrderSolverAttribute att_name att_value
The threshold value for the minimum curving cost smoothing function.
$block get/setHighOrderSolverAttribute ConvergenceCostThreshold value
The maximum threshold for deviation.
$block get/setHighOrderSolverAttribute DeviationThreshold value
Controls which linear and inserted and projected, high-order surface nodes can be moved during smoothing.
$block get/setHighOrderSolverAttribute FreezeSurfaceNodes value
Specifies a minimum polynomial degree for mixed order mesh elevation.
$block get/setHighOrderSolverAttribute PolynomialDegreeMin value
Specifies the polynomial degree for constant order mesh elevation or the maximum polynomial degree for mixed order mesh elevation.
$block get/setHighOrderSolverAttribute PolynomialDegreeMax value
The step size factor used when smoothing the high-order nodes.
$block get/setHighOrderSolverAttribute StepSizeRelaxationFactor value
The default minimum curving cost threshold value assigned to a block when it is created.
pw::Block get/setDefault ConvergenceCostThreshold value
The default deviation threshold value assigned to a block when it is created.
pw::Block get/setDefault DeviationThreshold value
The default freeze method value assigned to a block when it is created.
pw::Block get/setDefault FreezeSurfaceNodes value
The default minimum polynomial degree value assigned to a block when it is created.
pw::Block get/setDefault PolynomialDegreeMin value
The default max polynomial degree value assigned to a block when it is created.
pw::Block get/setDefault PolynomialDegreeMax value
The default step size factor value assigned to a block when it is created.
pw::Block get/setDefault StepSizeRelaxationFactor value
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