pw:: BlockStructured

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.

Derives From

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

Summary

pw:: BlockStructured	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.
Static Actions
create	This action creates a new structured block object.
createFromDomains	This action creates new structured block objects from the given domains.
createFromPoints	This action, given a list of lists of lists of xyz values, creates a new structured block from those xyz values.
join	This action joins as many of the given structured blocks together as possible.
Static Defaults
InteriorControl (Default)	This gets/sets the default interior control function of a structured block when it is created.
FaceControl (Default)	This gets/sets the default boundary control function of all faces of a structured block when it is created.
SolverEngine (Default)	This gets/sets the default elliptic solver engine employed when smoothing a structured block.
Instance Actions
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.
getLinearIndex	This converts a block’s ijk index to a linear 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.
getCell	This action gets the indices of the given cell.
getXYZsAtIndex	This action gets a grid of points in the given direction at the given index.
canReExtrude	This action returns true if the entity can be re-extruded.
createSubGrid	This action creates a subgrid on this block.
getSubGridCount	This action gets the number of subgrids in this block.
getSubGrid	This action gets the subgrid at the given index.
getSubGrids	This action gets the subgrid list.
removeSubGrid	This action removes the subgrid from the block.
getEllipticSolverResidual	This action gets the last elliptic solver residual info for the block/subgrid at the given index.
getFace	This action gets the face at the given index or computational boundary.
addFace	This action adds a face to the block.
split	This action splits this block in the given direction at the given indices.
join	This action joins the given block to this block.
setOrientation	This action sets the IJK orientation of this block.
alignOrientation	This action aligns the IJK orientation of the given blocks with this block.
lockInterior	This action locks the interior points from being automatically freed.
unlockInterior	This action unlocks the interior points and free if there are no more locks on the block.
getHandedness	This actioin gets whether a block is left- or right-handed.
getEllipticSolverAttribute	This action gets the named elliptic solver attribute.
setEllipticSolverAttribute	This action sets the named elliptic solver attribute.
getExtrusionSolverAttribute	This gets the named extrusion solver attribute.
setExtrusionSolverAttribute	This sets the named extrusion solver attribute.
getExtrusionBoundaryCondition	This gets the boundary condition at a given connector region.
setExtrusionBoundaryCondition	This sets the boundary condition at a given connector region.
Elliptic Solver Attributes
SolverEngine	This attribute is the elliptic solver engine employed when smoothing a structured block.
MultiGridRelaxationFactor	This attribute is the relaxation factor of the multi-grid algorithm.
MultiGridProlongationFactor	This attribute is the Prolongation factor of the multi-grid algorithm.
RelaxationFactor	This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
InteriorControl	This attribute is the interior control function of a structured block.
FaceControl	This attribute is the boundary control function of a structured block face.
FaceSpacingCalculation	This attribute is the boundary control function spacing calculation method.
FaceSpacingBlend	This attribute is the boundary control function spacing blend method.
FaceAngleCalculation	This attribute is the boundary control function angle calculation method.
FaceAngleBlend	This attribute is the boundary control function angle blend method.
FaceConstraint	This attribute is the boundary constraints of the structured block.
Generic Extrusion Solver Attributes
Mode	This gets/sets the extrusion mode of this block.
StopAtHeight	This gets/sets the current state of the height stop condition.
StopAtAspectRatio	This gets/sets or disables the max aspect ratio stop condition.
StopAtSkewAngle	This gets/sets or disables the min skew angle stop condition.
StopAtPositiveSkewJacobian	This gets/sets the state of the positive skew Jacobian stop condition.
StopAtZeroJacobian	This gets/sets the state of the zero Jacobian stop condition.
StopAtNegativeSkewJacobian	This gets/sets the state of the negative skew Jacobian stop condition.
StopAtNegativeJacobian	This gets/sets the state of the negative Jacobian stop condition.
DirectionFlipped	This gets/sets the extrusion direction.
PlaneAngleTolerance	This specifies the angle tolerance for determining when an arbitrary plane BC is considered equal to a Cartesian plane BC.
PlaneDeviationTolerance	This specifies the deviation tolerance for determining when an arbitrary plane BC is considered to be planar.
Translational Extrusion Solver Attributes
TranslateDirection	This gets/sets the direction vector for translate extrusion.
TranslateDistance	This gets/sets the distance for translate extrusion.
Path Extrusion Solver Attributes
PathConnectors	This gets/sets the list of connectors for a path extrusion.
PathMaximumSteps	This gets the maximum number of steps available as the path extrusion is configured
PathUseTangent	This gets/sets the flag indicating if the path extrusion should be rotated tangentially to the path connector.
Rotational Extrusion Solver Attributes
RotateAxisStart	This gets/sets the axis start location for rotate extrusion.
RotateAxisEnd	This gets/sets the axis end location for rotate extrusion.
RotateAngle	This gets/sets the rotational extrusion angle in degrees.
Normal Extrusion Solver Attributes
NormalExplicitSmoothing	This gets/sets the explicit smoothing coefficient for the transverse direction.
NormalImplicitSmoothing	This gets/sets the implicit smoothing coefficient for the transverse direction.
NormalKinseyBarthSmoothing	This gets/sets the Kinsey-Barth coefficient to control smoothing in the marching direction.
NormalVolumeSmoothing	This determines how rapidly grid point clustering along the initial grid will be relaxed as the grid is extruded.
NormalInitialStepSize	This gets/sets the size of the first marching step to value.
NormalMaximumStepSize	This gets/sets a upper limit for the marching step size.
NormalMinimumStepSize	This gets/sets a upper limit for the marching step size.
NormalCornerFactor	This gets/sets a scale factor for reducing the local marching step in convex regions and increasing the marching step size in concave regions.
NormalDirectionRelaxation	This gets/sets the normals in the marching direction are smoothed locally using a LaPlace filter.
NormalDirectionRelaxationIterations	The gets/sets the normals in the marching direction are smoothed locally using a Lalace filter.
NormalStepSizeRelaxation	This gets/sets the marching step size is smoothed locally using a LaPlace filter.
NormalStepSizeRelaxationIterations	This gets/sets the marching step size is smoothed locally using a LaPlace filter.
NormalQualitySmoothing	This enables/disables normal smoothing based on a quality metric.
NormalInteriorOnlySmoothing	This enables/disables interior-only quality-based smoothing.
NormalMaximumIterationsSmoothing	This specifies/retrieves the maximum number of smoothing iterations.
NormalBlendExponentSmoothing	This specifies/retrieves the blend exponent for smoothing.
Spacing Extrusion Solver Attributes
SpacingMode	This gets/sets the spacing configuration for the extrusion.
SpacingGrowthFactor	This gets/sets how the marching step size will grow from its initial value.
SpacingConnectors	This gets/sets the collection of connector-object and subconnector- index pairs that specify how the marching step size will grow from its initial value.

createFromDomains

pw::BlockStructured createFromDomains ?-poleDomains poleDomainsVar? ?-reject rejectVar? domains

This action creates new structured block objects from the given domains.

Parameters

-poleDomains poleDomainsVar	This optional parameter is the name string of the variable that receives a list of new pw::DomainStructured objects that were automatically created as pole domains in order to complete the blocks created.
-reject rejectVar	This optional parameter is the name string of the variable that receives a list of pw::DomainStructured objects that were not used in creating the blocks.
domains	This required parameter is a list of pw::DomainStructured objects.

Returns

This action returns a list of new pw::BlockStructured objects.

Information

This command supports progress updates.

Notes

While this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input domains. The blocks may be created in a different order or may be created with different orientations. Use the explicit block building routines (pw::FaceStructured.create, pw::BlockStructured.create, pw::Face.addDomain, and pw::Block.addFace commands) to build the block in a controlled manner.

If this command is run inside of a Create pw::Mode, it will only be able to assemble blocks from entities that were created within the same pw::Mode. If entities created outside of the pw::Mode are also included, the assembly will fail. Instead, use explicit assembly by creating the pw::FaceStructured objects directly.

createFromPoints

pw::BlockStructured createFromPoints points

This action, given a list of lists of lists of xyz values, creates a new structured block from those xyz values. The dimensions of the block are determined by the length of the list (k-direction) of lists (j-direction) of lists of xyz values (i-direction).

Parameters

points

This required parameter is a list of lists of lists of xyz vector values to be used to define the structured block.

Returns

This action returns the newly defined structured block.

Example

This example creates a list of lists of lists of xyz values to create a structured block.

Code

package require PWI_Glyph 3.18.3
set idim 5
set jdim 7
set kdim 9
set origin {10 10 10}
set ivec {4 0 0}
set jvec {0 6 0}
set kvec {0 0 8}

set p000 $origin
set p001 [pwu::Vector3 add $p000 $ivec]
set p010 [pwu::Vector3 add $p000 $jvec]
set p011 [pwu::Vector3 add $p001 $jvec]
set p100 [pwu::Vector3 add $p000 $kvec]
set p101 [pwu::Vector3 add $p100 $ivec]
set p110 [pwu::Vector3 add $p100 $jvec]
set p111 [pwu::Vector3 add $p101 $jvec]
# Generate GgVec3Array3
set pts [list]
for {set k 1} {$k <= $kdim} {incr k} {
  set z [ expr { [lindex $p000 2] + $kdim - [ expr {[lindex $kvec 2] * $k / $kdim} ] } ]
  set jList [list]
  for {set j 1} {$j <= $jdim} {incr j} {
    set y [ expr { [lindex $p000 1] + $jdim - [ expr {[lindex $jvec 1] * $j / $jdim} ] } ]
    set iList [list]
    for {set i 1} {$i <= $idim} {incr i} {
      set x [ expr { [lindex $p000 0] + $idim - [ expr {[lindex $ivec 0] *$i / $idim} ] } ]
      set pt [pwu::Vector3 set $x $y $z]
      lappend iList $pt
    }
    lappend jList $iList
  }
  lappend pts $jList
}

set blk [pw::BlockStructured createFromPoints $pts]
puts "Dimensions [$blk getDimensions]"

Output

Dimensions [5 7 9]

getExtrusionBoundaryCondition

$block getExtrusionBoundaryCondition edge_con_pair

This gets the boundary condition at a given connector region.

Parameters

edge_con_pair

This required parameter is a two element list consisting of the integer edge index and the integer connector index within the edge.

Returns

This action returns the string name of the boundary condition, except in the case of Splay, DatabaseConstrained and AdjacentGrid. In those cases, this action returns a list containing the string name of the boundary condition and the float splay factor (for Splay) or the pertinent entities (pw::DatabaseEntity for DatabaseConstrained or pw::DomainStructured for AdjacentGrid).

Boundary Conditions

Splay	Grid boundaries move outward according to the splay factor.
ConstantX	Grid points on the front maintain a constant X coordinate value.
ConstantY	Grid points on the front maintain a constant Y coordinate value.
ConstantZ	Grid points on the front maintain a constant Z coordinate value.
SymmetryX	Grid symmetry is maintained in the X direction.
SymmetryY	Grid symmetry is maintained in the Y direction.
SymmetryZ	Grid symmetry is maintained in the Z direction.
FloatingX	Grid points on the front maintain a constant Y and Z coordinate value (only X floats).
FloatingY	Grid points on the front maintain a constant Z and X coordinate value (only Y floats).
FloatingZ	Grid points on the front maintain a constant X and Y coordinate value (only Z floats).
ArbitraryPlane	Determines the plane in which the connector lies and constrains the grid points to that plane as the front advances.
DatabaseConstrained	Grid points in the front are projected to one or more database surfaces using closest point projection method.
AdjacentGrid	Grid points in the front are constrained to match the grid points in an existing domain.
Connection	Grid points are constrained through an internal grid connection within the front. This condition is set automatically and cannot be set explicitly. A Connection boundary cannot be changed to another condition type.

pw:: BlockStructured

Derives From

Static Actions

create

Parameters

Returns

See Also

createFromDomains

Parameters

Returns

Information

Notes

See Also

createFromPoints

Parameters

Returns

See Also

Example

join

Parameters

Returns

Information

Static Defaults

InteriorControl (Default)

Type

Default

See Also

FaceControl (Default)

Type

Default

See Also

SolverEngine (Default)

Type

Default

See Also

Instance Actions

getPoint

Parameters

Returns

Information

See Also

setPoint

Parameters

Returns

Information

See Also

isInteriorIndex

Parameters

Information

Returns

getAdjacentIndices

Parameters

Information

Returns

getCellsUsingIndex

Parameters

Information

Returns

getLinearIndex

Parameters

Returns

getPosition

Parameters

Returns

Information

See Also

getXYZ

Parameters

Returns

Information

See Also

getCell

Parameters

Information

Returns

Notes

getXYZsAtIndex

Parameters

Returns

canReExtrude