pw:: BlockUnstructured

An unstructured block is a watertight collection of face-connected volume elements (tetrahedral, hexahedral, prism, pyramid, etc.) bounded by one or more pw::FaceUnstructured faces, none of which can be degenerate (pole domain).

Derives From

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

Summary

pw:: BlockUnstructured	An unstructured block is a watertight collection of face-connected volume elements (tetrahedral, hexahedral, prism, pyramid, etc.)
Static Actions
create	This action creates a new unstructured block object.
createFromDomains	This action creates new unstructured block objects from the given domains.
createFromPoints	This action, given a list of xyz vector values and at least one cell-type array, creates a new unstructured block.
split	This action splits the given TRex blocks into either a number of of maximum full prism layer blocks, or into a number of maximum mixed cell blocks dividing the anisotropic and isotropic cells.
join	This action joins as many of the given unstructured blocks together as possible.
combineAnisoCells	This action combines anisotropic tet and pyramid cells in TRex-defined blocks into tet, pyramid, prism and hex cells.
Static Defaults
BoundaryDecay (Default)	This default is the boundary decay factor of an unstructured block when it is created.
BackgroundSpacing (Default)	This default is the background grid spacing of an unstructured block when it is created.
EdgeMaximumGrowthRate (Default)	This default is the maximum spacing growth rate along an edge of an unstructured block when it is created.
EdgeMaximumLength (Default)	This default is the maximum edge length of an unstructured block when it is created.
EdgeMinimumLength (Default)	This default is the minimum edge length of an unstructured block when it is created.
InteriorAlgorithm (Default)	This default is the algorithm that will be used when initializing the interior portion of an unstructured block when it is created.
PyramidMaximumHeight (Default)	This default is the maximum pyramid height of an unstructured block when it is created.
PyramidMinimumHeight (Default)	This default is the minimum pyramid height of an unstructured block when it is created.
PyramidAspectRatio (Default)	This default is the pyramid aspect ratio of an unstructured block when it is created.
TRexCellType (Default)	This default is the type of cells generated by TRex of an unstructured block when it is created.
TRexMaximumLayers (Default)	This default is the maximum number of T-Rex layers of an unstructured block when it is created.
TRexFullLayers (Default)	This default is the minimum number of fully structured TRex layers of an unstructured block when it is created.
TRexGrowthRate (Default)	This default is the growth rate of TRex layers of an unstructured block when it is created.
TRexPushAttributes (Default)	This default is the flag for pushing TRex attributes onto the connectors and domains of an unstructured block when a it is created.
TRexSpacingSmoothing (Default)	This default is the number of smoothing sweeps to apply to the initial spacing values of TRex layers of an unstructured block when it is created.
TRexSpacingRelaxationFactor (Default)	This default is the relaxation factor of smoothing sweeps to apply to the initial spacing values of TRex layers for an unstructured block when it is created.
TRexIsotropicSeedLayers (Default)	This default is the number of TRex isotropic seed layers for an unstructured block when it is created.
TRexLayerSubdivisions (Default)	This default controls the maximum cell height multiplier to be applied at the beginning of each T-Rex layer.
TRexCollisionBuffer (Default)	This default is the minimum buffer to be maintained between encroaching extruded tetrahedron of an unstructured block when it is created.
TRexAnisotropicIsotropicBlend (Default)	This default is the rate at which anisotropic triangles are blended into isotropic triangles on the interior of an unstructured block when it is created.
TRexIsotropicHeight (Default)	This default specifies the scale factor to be applied to the local isotropic height at which T-Rex stops layer growth via deformation, decimation or refinement.
TRexSkewCriteriaDelayLayers (Default)	This default is the number of layers to delay checking for the quality criteria of the TRex cells of an unstructured block when it is created.
TRexSkewCriteriaMaximumAngle (Default)	This default is the maximum included angle quality threshold for TRex cells of an unstructured block when it is created.
TRexSkewCriteriaEquivolume (Default)	This default is the maximum equivolume quality threshold for TRex cells of an unstructured block when it is created.
TRexSkewCriteriaEquiangle (Default)	This default is the maximum equiangle quality threshold for TRex cells of an unstructured block when it is created.
TRexSkewCriteriaCentroid (Default)	This default is the maximum centroid skew quality threshold for TRex cells of an unstructured block when it is created.
TRexVolumeFunction (Default)	This default is the method to be used when computing prism cell volumes for TRex cells of an unstructured block when it is created.
OversetAdaptAmplification (Default)	This default is the adaption target edge length amplification factor of an unstructured block when it is created.
OversetAdaptTargets (Default)	This default is the orphan remediation and fringe improvement adaption targets of an unstructured block when it is created.
VoxelAlignment (Default)	This default represents the voxel alignment method to be used for an unstructured block when it is created.
VoxelMinimumSize (Default)	This default is the minimum voxel size of the voxel mesh of an unstructured block when it is created.
VoxelMaximumSize (Default)	This default is the maximum voxel size of the voxel mesh of an unstructured block when it is created.
VoxelTransitionLayers (Default)	This default is the number of layers between voxel size transitions of the voxel mesh of an unstructured block when it is created.
Instance Actions
getInitializationErrorCount	This action gets the number of errors from the last attempt at initializing the block.
getTRexFront	This action takes an input list of domains on the block and determines which TRex fronts they lie on, if any.
getTRexLayersOnFront	This action takes a list of front ids and determines how many full and max layers are associated with the front.
splitByDistance	This action splits the unstructured block into a number of new blocks based on a distance from specified domains within the block.
splitByFronts	This action splits the unstructured block into a number of new blocks, splitting along fronts in specified domains in the block by a specified number of layers.
getInitializationError	This action gets a specific error message from the last initialization attempt.
getInitializationErrors	This action gets the error message list.
getTRexCellCount	This action gets the number of T-Rex cells in the block.
getTRexTetCount	This action gets the number of T-Rex tet cells in the block.
getTRexPyrCount	This action gets the number of T-Rex pyr cells in the block.
getTRexPrismCount	This action gets the number of T-Rex prism cells in the block.
getTRexHexCount	This action gets the number of T-Rex hex cells in the block.
getVoxelTetRange	This action returns the first and last tet in the array that were formed from voxel cells.
getVoxelPyrRange	This action returns the first and last pyramid in the array that were formed from voxel cells.
getVoxelPrismRange	This action returns the first and last prism in the array that were formed from voxel cells.
getVoxelHexRange	This action returns the first and last hex in the array that were formed from voxel cells.
getIsoTetRange	This action returns the first and last tet in the array that were formed from voxel cells.
getIsoPyrRange	This action returns the first and last pyramid in the array that were formed from isotropic cells.
getIsoPrismRange	This action returns the first and last prism in the array that were formed from isotropic cells.
getIsoHexRange	This action returns the first and last hex in the array that were formed from isotropic cells.
getAnisoTetRange	This action returns the first and last tet in the array that were formed from voxel cells.
getAnisoPyrRange	This action returns the first and last pyramid in the array that were formed from anisotropic cells.
getAnisoPrismRange	This action returns the first and last prism in the array that were formed from anisotropic cells.
getAnisoHexRange	This action returns the first and last hex in the array that were formed from anisotropic cells.
getTRexFullLayerCount	This action gets the number of T-Rex full layers in the block generated by the last run of the solver.
getTRexTotalLayerCount	This action gets the number of T-Rex total layers in the block generated by the last run of the solver.
getTRexTotalLayerHeight	This action gets the non-dimensional summed height of a TRex front at a specified layer.
getTRexMatchDomainCount	This action gets the number of match domains emanating from the adjacent grid/wall BC conditions within this block.
getTRexMatchInitialSpacing	This action gets the minimum, average, and maximum initial spacing of the match domains connected to the adj grid/wall BCs of this block.
getTRexMatchGrowthRate	This action gets the minimum, average, and maximum growth rates of the match domains connected to the adj grid/wall BCs of this block.
getTRexMatchLayerCount	This action gets the minimum, average, and maximum layer count of the match domains connected to the adj grid/wall BCs of this block.
join	This action joins the given block to this block.
freeInterior	This action frees the block’s interior points.
pushAttributes	This action pushes the block’s attributes onto the match domains if the TRexPushAttributes attribute is true.
boundaryAdaptation	This action adapts the block’s boundaries based on the current settings of the block.
removeFace	This action removes a face from the block.
getOuterFace	This action returns the block’s outer face.
getBoundaryEdgeMinimumLength	This action gets the calculated minimum boundary edge length based on triangular area of the boundary cells.
getBoundaryEdgeMaximumLength	This action gets the calculated maximum boundary edge length based on triangular area of the boundary cells.
getVolumeEdgeMinimumLength	This action gets the calculated minimum volume edge length based on tetrahedral volume of the cells.
getVolumeEdgeMaximumLength	This action gets the calculated maximum volume edge length based on tetrahedral volume of the cells.
getPyramidBaseMaximumHeight	This action gets the calculated maximum height of the pyramids based on the prescribed aspect ratio and the base area of the cells.
getPyramidBaseMinimumHeight	This action gets the calculated minimum height of the pyramids based on the prescribed aspect ratio and the base area of the cells.
getAutomaticVoxelMinimumSize	This action gets the automatic minimum size used when the VoxelMinimumSize attribute is set to 0.0.
getAutomaticVoxelMaximumSize	This action gets the automatic maximum size used when the VoxelMinimumSize parameter is set to 0.0.
getUnstructuredSolverAttribute	This action gets the named unstructured solver attribute.
setUnstructuredSolverAttribute	This action sets the named unstructured solver attribute.
Unstructured Solver Attributes
BoundaryDecay	This attribute is the boundary decay factor of an unstructured block.
BackgroundSpacing	This attribute is the background spacing of an unstructured block.
EdgeMaximumGrowthRate	This attribute is the maximum spacing growth rate along an edge of an unstructured block.
EdgeMaximumLength	This attribute is the maximum edge length of an unstructured block.
EdgeMinimumLength	This attribute is the minimum edge length of an unstructured block.
InteriorAlgorithm	This attribute is the algorithm that will be used when initializing the interior portion of an unstructured block.
PyramidMaximumHeight	The maximum pyramid height of an unstructured block
PyramidMinimumHeight	This attribute is the minimum pyramid height of an unstructured block.
PyramidAspectRatio	This attribute is the pyramid aspect ratio of an unstructured block.
TRexCellType	This attribute controls what type of cells a T-Rex generated block will contain after generation.
TRexMaximumLayers	This attribute is the maximum number of TRex layers of the block.
TRexFullLayers	This attribute is the minimum number of fully structured TRex layers of the block.
TRexGrowthRate	This attribute is the growth rate of TRex layers for the block.
TRexPushAttributes	This attribute is the flag for pushing TRex attributes onto the connectors and domains of this block.
TRexSpacingSmoothing	This attribute is the number of smoothing sweeps to apply to the initial spacing values of TRex layers of the block.
TRexSpacingRelaxationFactor	This attribute is the relaxation factor of smoothing sweeps to apply to the initial spacing values of TRex layers for the block.
TRexIsotropicSeedLayers	This attribute is the number of TRex isotropic seed layers for the block.
TRexLayerSubdivisions	This attribute is the maximum cell height multiplier to be applied at the beginning of each T-Rex layer.
TRexCollisionBuffer	This attribute specifies the minimum buffer to be maintained between encroaching extruded tetrahedron.
TRexAnisotropicIsotropicBlend	This attribute specifies the rate at which anisotropic triangles are blended into isotropic triangles on the block interior.
TRexSkewCriteriaDelayLayers	This attribute is the number of layers to delay checking for the quality criteria of the TRex cells.
TRexSkewCriteriaMaximumAngle	This attribute specifies the maximum included angle quality threshold for TRex cells.
TRexSkewCriteriaEquivolume	This attribute specifies the maximum equivolume quality threshold for TRex cells.
TRexSkewCriteriaEquiangle	This attribute specifies the maximum equiangle quality threshold for TRex cells.
TRexSkewCriteriaCentroid	This attribute specifies the maximum centroid skew quality threshold for TRex cells.
TRexSkewCriteriaMinimumAngle	This attribute specifies the minimum included angle quality threshold for TRex cells.
TRexIsotropicHeight	This attribute specifies the scale factor to be applied to the local isotropic height at which T-Rex stops layer growth via deformation, decimation or refinement.
TRexVolumeFunction	This attribute specifies the method to be used when computing prism cell volumes for TRex cells.
TRexGrowthProfile	This attribute specifies the growth rate for each anisotropic layer.
OversetAdaptAmplification	This attribute is the adaption target edge length amplification factor of an unstructured block.
OversetAdaptTargets	This attribute sets the orphan remediation and fringe improvement adaption targets to be applied to an unstructured block run in the unstructured solver.
VoxelAlignment	This attribute represents the voxel alignment method to be used for an unstructured block when it is created.
VoxelMinimumSize	This attribute is the minimum voxel size of the voxel mesh of this block.
VoxelMaximumSize	This attribute is the maximum voxel size of the voxel mesh of this block.
VoxelTransitionLayers	This attribute is the number of layers between voxel size transitions of the voxel mesh of this block.
WCNSmoothConvergenceCostThreshold	A cell is considered sufficiently “smoothed” if its cost value meets or exceeds this attribute’s value.
WCNSmoothCostAngleThreshold	Only cells with a cost angle above this limit are smoothed.
WCNSmoothRelaxationFactor	Only controls the magnitude of point smoothing movement per iteration.

createFromDomains

pw::BlockUnstructured createFromDomains ?-reject rejectVar? ?-fillVoids? ?-voids voidsVar? ?-addBaffles? ?-baffles bafflesVar? domains

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

Parameters

-reject rejectVar	This optional parameter is a string variable name to receive a list of pw::Domain objects that were not used in creating the blocks.
-fillVoids	This optional flag specifies that internal, closed block faces (aka voids or holes) will also be assembled into blocks. The returned list of blocks will include the outermost block and all of the blocks assembled to fill its voids. By default internal, closed block faces are not assembled and are left as voids (holes) in their surrounding block.
-voids voidsVar	This optional parameter is a string variable name to receive the subset of returned pw::BlockUnstructured objects that were created to fill block voids. This parameter is ignored if -fillVoids is not also specified.
-addBaffles	This optional parameter specifies that internal, non-closed, baffle faces are to be added to their surrounding block. By default, baffle faces are not added (and returned in rejectVar).
-baffles bafflesVar	This optional parameter is a string variable name to receive the pw::FaceUnstructured objects that were added as baffles to the assembled blocks. This parameter is ignored if -addBaffles is not also specified.
domains	This required parameter is a list of pw::Domain objects.

Returns

This action returns a list of new pw::BlockUnstructured objects. Multiple blocks will be returned if the domains form multiple closed, disjoint regions or if -fillVoids is specified and the domains form multiple closed, nested regions (or any combination of these).

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, for example. Use the explicit block building routines ( pw::FaceUnstructured.create, pw::BlockUnstructured.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::FaceUnstructured objects directly.

Example

This example assembles all visible and selectable domains into as many blocks as possible with all voids (holes) filled and baffles.

Code

package require PWI_Glyph 2.17.2
# Get all visible and selectable domains
set allDoms [pw::Grid getAll -type pw::Domain]
set doms {}
foreach dom $allDoms {
  if { ![pw::Display isLayerVisible [$dom getLayer]] } {
    continue
  } elseif { ![$dom getEnabled] } {
    continue
  } else {
    lappend doms $dom
  }
}

# Assemble blocks from these domains
set blks [pw::BlockUnstructured createFromDomains \
    -reject unusedDoms -fillVoids -voids voidBlks -addBaffles \
    -baffles baffleFaces $doms]

# Output the results
puts "Assembled a total of [llength $blks] blocks."
if { [llength $voidBlks] > 0 } {
  puts "[llength $voidBlks] of these were used to fill voids."
  foreach blk $voidBlks {
    puts "  [$blk getName] ($blk)"
  }
} else {
  puts "There were no void blocks."
}

set baffleLen [llength $baffleFaces]
if { $baffleLen > 0 } {
  puts "$baffleLen baffle faces were added."
  foreach face $baffleFaces {
    puts "  $face"
    set faceDoms [$face getDomains]
    foreach faceDom $faceDoms {
      puts "    [$faceDom getName] ($faceDom)"
    }
  }
} else {
  puts "No baffle faces were added."
}

if { [llength $unusedDoms] > 0 } {
  puts "[llength $unusedDoms] domains were unused."
  foreach dom $unusedDoms {
    puts "  [$dom getName] ($dom)"
  }
} else {
  puts "All domains were used."
}

Output

Assembled a total of 3 blocks.
Of these blocks, 2 were used to fill voids.
  blk-1 (::pw::BlockUnstructured_6)
  blk-2 (::pw::BlockUnstructured_7)
1 baffle faces were added.
  ::pw::FaceUnstructured_2
    dom-17 (::pw::DomainUnstructured_13)
    dom-3 (::pw::DomainUnstructured_24)
    dom-4 (::pw::DomainUnstructured_25)
1 domains were unused.
  dom-5 (::pw::DomainUnstructured_26)

createFromPoints

pw::BlockUnstructured createFromPoints ?-tetrahedrons tetCellArray? ?-pyramids pyramidCellArray? ?-prisms prismCellArray? ?-hexahedrons hexCellArray? ?-splitAngle angle? ?-splitMultiloop? points

This action, given a list of xyz vector values and at least one cell-type array, creates a new unstructured block.

Parameters

The following optional cell array parameters (at least one of which is required) are each a list of lists. The sub-lists represent indices into the points list for each vertex of the particular cell. For example, there are 4 vertices for each tetrahedron. Therefore, the ‘tetCellArray’ will consist of N sub-lists, where each sub-list has 4 indices representing the four vertices of the tetrahedron.

-tetrahedrons tetCellArray	This optional parameter is a list of N cells, where each cell list is 4 elements long (one element for each tetrahedron vertex, each of which is an index into the points array).
-pyramids pyramidCellArray	This optional parameter is a list of N cells, where each cell list is 5 elements long (one element for each pyramid vertex, each of which is an index into the points array).
-prisms prismCellArray	This optional parameter is a list of N cells, where each cell list is 6 elements long (one element for each prism vertex, each of which is an index into the points array).
-hexahedrons hexCellArray	This optional parameter is a list of N cells, where each cell list is 8 elements long (one element for each hexahedron vertex, each of which is an index into the points array).

The following are additional optional parameters, none of which is required.

-splitAngle splitAngle	This optional parameter is the float angle at which to split connectors.
-splitMultiloop	This optional flag will split domains with more than 1 loop.
points	This required parameter is a list of vector point values to be used to define the block.

Returns

This action returns the newly created block.

Example

This example creates an unstructured block from a list of points and prism cell connectivity.

Code

set idim 5
set jdim 7
set kdim 9

set pts [list]

# Grid points
for {set k 0} {$k < $kdim} {incr k} {
  for {set j 0} {$j < $jdim} {incr j} {
    for {set i 0} {$i < $idim} {incr i} {
      set pt [pwu::Vector3 set $i $j $k]
      lappend pts $pt
    }
  }
}

proc getOffset { x y z } {
  global idim jdim
  return [expr {$x + $idim * [expr {$y + $jdim * $z} ] } ]
}

proc generatePts {stencils dim delta} {
  global idim jdim kdim
  set cells [list]
  for {set k 0} {$k < $kdim - $delta} {incr k $delta} {
    for {set j 0} {$j < $jdim - $delta} {incr j $delta} {
      for {set i 0} {$i < $idim - $delta} {incr i $delta} {
        for {set s 0} {$s < [llength $stencils]} {incr s} {
          set stencil [lindex $stencils $s]
          set cell [list]
          for {set p 0} {$p < $dim} {incr p} {
            set vert [lindex $stencil $p]
            set x [expr {[lindex $vert 0] + $i}]
            set y [expr {[lindex $vert 1] + $j}]
            set z [expr {[lindex $vert 2] + $k}]
            lappend cell [getOffset $x $y $z]
          }
          lappend cells $cell
        }
      }
    }
  }
  return $cells
}

# Prism stencils
set prismStencil_1 [list]
lappend prismStencil_1 [pwu::Vector3 set 0 0 0]
lappend prismStencil_1 [pwu::Vector3 set 1 1 0]
lappend prismStencil_1 [pwu::Vector3 set 0 1 0]
lappend prismStencil_1 [pwu::Vector3 set 0 0 1]
lappend prismStencil_1 [pwu::Vector3 set 1 1 1]
lappend prismStencil_1 [pwu::Vector3 set 0 1 1]

set prismStencil_2 [list]
lappend prismStencil_2 [pwu::Vector3 set 0 0 0]
lappend prismStencil_2 [pwu::Vector3 set 1 0 0]
lappend prismStencil_2 [pwu::Vector3 set 1 1 0]
lappend prismStencil_2 [pwu::Vector3 set 0 0 1]
lappend prismStencil_2 [pwu::Vector3 set 1 0 1]
lappend prismStencil_2 [pwu::Vector3 set 1 1 1]

set prismStencils [list]
set cnt 2
for {set i 1} {$i <= $cnt} {incr i} {
  lappend prismStencils [set prismStencil_$i]
}

set prismCells [generatePts $prismStencils 6 1]
set prismBlk [pw::BlockUnstructured createFromPoints -prisms $prismCells $pts]

set domain1 [pw::Grid getByName "dom-1"]
set domain2 [pw::Grid getByName "dom-2"]
set block [pw::Grid getByName "blk-1"]
set frontId [$block getTRexFront [list $domain1 $domain2]
puts "Domains lie on fronts $frontId."

pw:: BlockUnstructured

Derives From

Static Actions

create

Parameters

Returns

See Also

createFromDomains

Parameters

Returns

Information

Notes

Example

createFromPoints

Parameters

Returns

Example

split

Parameters

Returns

Information

Example

join

Parameters

Returns

Information

combineAnisoCells

Parameters

Returns

Information

Example

Static Defaults

BoundaryDecay (Default)

Type

Default

See Also

BackgroundSpacing (Default)

Type

Default

See Also

EdgeMaximumGrowthRate (Default)

Type

Default

See Also

EdgeMaximumLength (Default)

Type

Default

See Also

EdgeMinimumLength (Default)

Type

Default

See Also

InteriorAlgorithm (Default)

Type

Default

See Also

PyramidMaximumHeight (Default)

Type

Default

See Also

PyramidMinimumHeight (Default)

Type

Default

See Also

PyramidAspectRatio (Default)

Type

Default

See Also

TRexCellType (Default)

Type

Default

Information

See Also

TRexMaximumLayers (Default)

Type

Default

See Also

TRexFullLayers (Default)

Type

Default