pw::BlockUnstructured

pw::BlockUnstructured create

This action creates a new unstructured block object.

Parameters

This action has no parameters.

Returns

This action returns a new pw::BlockUnstructured object.

See Also

pw::Block.addFace

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

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

Parameters

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)

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.

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

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]

pw::BlockUnstructured split ?<-trexLayers | -trexFronts>? blocks

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.

Parameters

Returns

This action returns a heterogeneous list of the pw::BlockUnstructured and pw::BlockExtruded objects that were created and/or modified.

Information

This command supports progress updates.

Example

This example creates prism (extruded) and tetrahedral cell blocks, maximizing the number of anisotropic prism layers that can be recombined while keeping the block topology intact.  This example assumes that all the unstructured blocks in the system are TRex blocks.

Code

set blocks [pw::Grid getAll -type pw::BlockUnstructured]
set splits [pw::BlockUnstructured split -trexLayers $blocks]
puts "[llength $splits] blocks were created/modified."

Output

3 blocks were created/modified.

pw::BlockUnstructured join ?-reject rejectVar? blocks

This action joins as many of the given unstructured blocks together as possible.

Parameters

Returns

This action returns a list of the pw::BlockUnstructured objects that were joined.

Information

This command supports progress updates.

pw::BlockUnstructured combineAnisoCells blocks

This action combines anisotropic tet and pyramid cells in TRex-defined blocks into tet, pyramid, prism and hex cells.

Parameters

Returns

This action returns nothing.

Information

This command supports progress updates.

Example

This example combines anisotropic tet and pyramid cells in TRex-defined blocks into tet, pyramid, prism and hex cells.

Code

set blocks [pw::Grid getAll -type pw::BlockUnstructured]
pw::BlockUnstructured combineAnisoCells $blocks

pw::BlockUnstructured get/setDefault BoundaryDecay decay

This default is the boundary decay factor of an unstructured block when it is created.  This default is being replaced by pw::GridEntity.SizeFieldDecay and will be deprecated soon.  Getting or setting this default is the same as getting or setting the pw::GridEntity.SizeFieldDecay default.

Type

A float in the range [0, 1].

Default

The default value is 0.5.

See Also

BoundaryDecay

pw::BlockUnstructured get/setDefault BackgroundSpacing spacing

This default is the background grid spacing of an unstructured block when it is created.  This default is being replaced by pw::GridEntity.SizeFieldBackgroundSpacing and will be deprecated soon.  Getting or setting this default is the same as getting or setting the pw::GridEntity.SizeFieldBackgroundSpacing default.

Type

A float in the range (0, infinity).

Default

The default value is 0.0.

See Also

BackgroundSpacing

pw::BlockUnstructured get/setDefault EdgeMaximumGrowthRate growth_rate

This default is the maximum spacing growth rate along an edge of an unstructured block when it is created.

Type

A float in the range (1.0, infinity).

Default

The default value is 1.8.

See Also

EdgeMaximumGrowthRate

pw::BlockUnstructured get/setDefault EdgeMaximumLength < Boundary | length >

This default is the maximum edge length of an unstructured block when it is created.

Type

A float in the range (0, infinity).

Default

The default value is Boundary.

See Also

EdgeMaximumLength

pw::BlockUnstructured get/setDefault EdgeMinimumLength < Boundary | length >

This default is the minimum edge length of an unstructured block when it is created.

Type

A float in the range (0, infinity).

Default

The default value is Boundary.

See Also

EdgeMinimumLength

pw::BlockUnstructured get/setDefault InteriorAlgorithm algorithm

This default is the algorithm that will be used when initializing the interior portion of an unstructured block when it is created.  It only has effect

Type

A string with options < Delaunay | Voxel >.

Default

The default value is Delaunay.

See Also

InteriorAlgorithm

pw::BlockUnstructured get/setDefault PyramidMaximumHeight height

This default is the maximum pyramid height of an unstructured block when it is created.

Type

A float in the range [0, infinity).  Use 0 for unrestricted pyramid height.

Default

The default value is 0.

See Also

PyramidMaximumHeight

pw::BlockUnstructured get/setDefault PyramidMinimumHeight height

This default is the minimum pyramid height of an unstructured block when it is created.

Type

A float in the range [0, infinity).  Use 0 for unrestricted pyramid height.

Default

The default value is 0.

See Also

PyramidMinimumHeight

pw::BlockUnstructured get/setDefault PyramidAspectRatio ratio

This default is the pyramid aspect ratio of an unstructured block when it is created.

Type

A float in the range (0, infinity).

Default

The default value is 1.

See Also

PyramidAspectRatio

pw::BlockUnstructured get/setDefault TRexCellType value

This default is the type of cells generated by TRex of an unstructured block when it is created.

Type

A string with options < TetPyramid | TetPyramidPrismHex | AllAndReducePyramids | LegacyTetPyramidPrismHex | AllAndConvertWallDoms >.

Default

The default value is TetPyramidPrismHex

Information

TetPyramid indicates that generated cells will be stored as tets upon completion, except for pyramids necessarily placed adjacent to surface quads.

TetPyramidPrismHex means that a combination of tets, pyramids and prisms will be generated in the anisotropic (T-Rex) portion of the mesh.  In addition, hexes will be generated off of surface quads.

AllAndReducePyramids is the same as TetPyramidPrismHex except that a pyramid will be placed on the top of every stack of hexes whenever possible.  This pyramid replaces the 7 cell elements (a base pyramid, 4 side pyramids and 2 top tets) otherwise used to transition from a quad face to triangles faces touching the isotropic tet cells.  This technique will reduce the pyramid count in a mesh significantly when the T-Rex layers stop short of their isotropic height.

LegacyTetPyramidPrismHex (Glyph only) will have nearly the same results as TetPyramidPrismHex, but T-Rex will proceed with it’s slower pre-V18.1 algorithm, representing each hex with 4 (rather than 2) triangles until a satisfactory transition cell is achieved.

AllAndConvertWallDoms (Glyph only) is the same as TetPyramidPrismHex except that triangles lying on growth surfaces will be combined into quads (as is practical) after the block is generated.  This will essentially combine prism stacks into hex stacks, further lowering the cell count.

See Also

TRexCellType

pw::BlockUnstructured get/setDefault TRexMaximumLayers layers

This default is the maximum number of T-Rex layers of an unstructured block when it is created.

Type

An integer in the range [0, infinity), where 0 means that there should be no TRex layers.

Default

The default value is 0.

See Also

TRexMaximumLayers

pw::BlockUnstructured get/setDefault TRexFullLayers layers

This default is the minimum number of fully structured TRex layers of an unstructured block when it is created.

Type

An integer in the range [0, infinity), where 0 means that there should be no minimum fully structured TRex layers.

Default

The default value is 0.

See Also

TRexFullLayers

pw::BlockUnstructured get/setDefault TRexGrowthRate growth_rate

This default is the growth rate of TRex layers of an unstructured block when it is created.

Type

A float in the range [1.0, infinity).

Default

The default value is 1.2.

See Also

TRexGrowthRate

pw::BlockUnstructured get/setDefault TRexPushAttributes push

This default is the flag for pushing TRex attributes onto the connectors and domains of an unstructured block when a it is created.

Type

A boolean, where true means that TRex attributes (initial spacing and growth rate or profile) are pushed down onto the connectors and domains.

Default

The default value is false.

See Also

TRexPushAttributes

pw::BlockUnstructured get/setDefault TRexSpacingSmoothing smooth

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.

Type

An integer in the range [0, infinity), where 0 means no smoothing is applied to the initial spacing values.

Default

The default value is 3.

See Also

TRexSpacingSmoothing

pw::BlockUnstructured get/setDefault TRexSpacingRelaxationFactor factor

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.

Type

A float in the range [0.0, 1.0), where 0 means no smoothing is applied to the initial spacing values.

Default

The default value is 0.7.

See Also

TRexSpacingRelaxationFactor

pw::BlockUnstructured get/setDefault TRexIsotropicSeedLayers value

This default is the number of TRex isotropic seed layers for an unstructured block when it is created.

Type

A string with value < UseRemainingLayers > or an explicit integer in the range [0, infinity), where 0 means that there should be no TRex isotropic seed layers.

Default

The default value is 0.

See Also

TRexIsotropicSeedLayers

pw::BlockUnstructured get/setDefault TRexLayerSubdivisions value

This default controls the maximum cell height multiplier to be applied at the beginning of each T-Rex layer.  At layer completion, cells will be split into multiple layers, thereby accelerating the T-Rex process substantially.  The multiple specified will be the maximum number of possible layer splits, but the actual number could be less based on the cell height proximity to isotropy.

Type

An integer in the range [1, 10].

Default

The default value is 1 (no layer multiple).

pw::BlockUnstructured get/setDefault TRexCollisionBuffer factor

This default is the minimum buffer to be maintained between encroaching extruded tetrahedron of an unstructured block when it is created.

Type

A float in the range [0, infinity).

Default

The default value is 0.5.

Info

This default is a multiplication factor of the current cell height.  With a factor of 0.5, a grid point will be extruded by a distance of 0.01 only if it may also be extruded by a distance of 0.015 without intersecting any other portion of the front.

See Also

TRexCollisionBuffer

pw::BlockUnstructured get/setDefault TRexAnisotropicIsotropicBlend blending

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.

Type

A float in the range [0, 1], where 0 disables blending and larger values increase the rate of blending.

Default

The default value is 0.5.

See Also

TRexAnisotropicIsotropicBlend

pw::BlockUnstructured get/setDefault TRexIsotropicHeight isoHeight

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.

Type

A float in the range (0.0, infinity).

Default

The default value is 1.0.

See Also

TRexIsotropicHeight

pw::BlockUnstructured get/setDefault TRexSkewCriteriaDelayLayers delay

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.

Type

An integer in the range [0, infinity), where 0 means that there should be no delay in checking the quality criteria.

Default

The default value is 0.

See Also

TRexSkewCriteriaDelayLayers

pw::BlockUnstructured get/setDefault TRexSkewCriteriaMaximumAngle angle

This default is the maximum included angle quality threshold for TRex cells of an unstructured block when it is created.

Type

A float in the range [60.0, 180.0], where 180.0 disables the quality check.

Default

The default value is 180.0.

See Also

TRexSkewCriteriaMaximumAngle

pw::BlockUnstructured get/setDefault TRexSkewCriteriaEquivolume threshold

This default is the maximum equivolume quality threshold for TRex cells of an unstructured block when it is created.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default value is 1.0.

See Also

TRexSkewCriteriaEquivolume

pw::BlockUnstructured get/setDefault TRexSkewCriteriaEquiangle threshold

This default is the maximum equiangle quality threshold for TRex cells of an unstructured block when it is created.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default value is 1.0.

See Also

TRexSkewCriteriaEquiangle

pw::BlockUnstructured get/setDefault TRexSkewCriteriaCentroid threshold

This default is the maximum centroid skew quality threshold for TRex cells of an unstructured block when it is created.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default value is 1.0.

See Also

TRexSkewCriteriaCentroid

pw::BlockUnstructured get/setDefault TRexSkewCriteriaApplyToHexTrans applyQual

This default determines whether T-Rex pyramid caps and transition hex cells will be tested against the user-set quality thresholds.

Type

A boolean, where false means that user-set TRex cell quality thresholds (other than positive volume checks) will not be applied to pyramid caps and transition hexes at the top of hex stacks.  Note that when true, failing quality of pyramid caps and transition hexes may cause the hex stack to be split into prism stacks.

Default

The default value is true.

See Also

TRexSkewCriteriaApplyToHexTrans

pw::BlockUnstructured get/setDefault TRexVolumeFunction function

This default is the method to be used when computing prism cell volumes for TRex cells of an unstructured block when it is created.

Type

A string with options < MinComponent | GreenGauss >.  MinComponent indicates that the TRex mesher should use the minimum component volume for prism volume computation.  GreenGauss indicates the use of the Green-Gauss method of prism volume computation.

Default

The default value is MinComponent.

See Also

TRexVolumeFunction

pw::BlockUnstructured get/setDefault OversetAdaptAmplification factor

This default is the adaption target edge length amplification factor of an unstructured block when it is created.

Type

A float in the range (0, infinity).

Default

The default value is 1.5.

See Also

OversetAdaptAmplification

pw::BlockUnstructured get/setDefault OversetAdaptTargets targets

This default is the orphan remediation and fringe improvement adaption targets of an unstructured block when it is created.

Type

A list of string with values < Fringes | Donors | Orphans | OrphanDonorCandidates >.

Default

The default value is [list Donors OrphanDonorCandidates].

See Also

OversetAdaptTargets

pw::BlockUnstructured get/setDefault VoxelAlignment alignment

This default represents the voxel alignment method to be used for an unstructured block when it is created.

Type

A string with options < Axes | Body >.

Default

The default value is Axes.

See Also

VoxelAlignment

pw::BlockUnstructured get/setDefault VoxelMinimumSize size

This default is the minimum voxel size of the voxel mesh of an unstructured block when it is created.

Type

A float in the range [0, infinity).

Default

The default value of this attribute is 0.0, which means to compute the minimum from either the size field (voxel blocks) or the block surface mesh (unstructured blocks).

See Also

VoxelMinimumSize

pw::BlockUnstructured get/setDefault VoxelMaximumSize size

This default is the maximum voxel size of the voxel mesh of an unstructured block when it is created.

Type

A float in the range [0, infinity).

Default

The default for this attribute is 0.0, which means to compute the maximum as a fraction (1/8) of the shortest edge of the extents (voxel blocks), or the block surface mesh (unstructured blocks).

See Also

VoxelMaximumSize

pw::BlockUnstructured get/setDefault VoxelTransitionLayers num

This default is the number of layers between voxel size transitions of the voxel mesh of an unstructured block when it is created.

Type

An integer in the range [1, 100].

Default

The default for this attribute is 1.

See Also

VoxelTransitionLayers

$block getInitializationErrorCount

This action gets the number of errors from the last attempt at initializing the block.

Parameters

This action has no parameters.

Returns

This action returns the integer number of error messages.

See Also

getInitializationError and getInitializationErrors

$block getTRexFront domains

This action takes an input list of domains on the block and determines which TRex fronts they lie on, if any.

Parameters

Returns

This action returns a list of integer values indicating the front numbers assigned to the domains during the previous TRex execution.  Returned values > 0 indicates the front number, a value of -1 indicates that the domain was set to Match, and a value of 0 indicates that the domain does not lie in the block, it was set to an OFF condition, or TRex has not been run.

Example

This example queries the frontIds assigned to dom-1 and dom-2 during the previous execution of T-Rex on blk-1.

Code

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

Output

Domains lie on fronts 2 3.

$block getTRexLayersOnFront fronts

This action takes a list of front ids and determines how many full and max layers are associated with the front.  Block must have anisotropic data.  Full layers will be reported as zero for uncombined blocks.

Parameters

Returns

This action returns a list of lists, each containing a full layer to max layer integer pair [list integer integer].  The list is ordered in parallel with passed fronts.

$block splitByDistance distance domains

This action splits the unstructured block into a number of new blocks based on a distance from specified domains within the block.  Cells in the unstructured block should be divided at triangles and quads where the stored cellIds differ.  Blocks containing recombination data will be combined prior to splitting.

Parameters

Returns

This action returns a homogeneous list of pw::BlockUnstructured objects.

Information

This command supports progress updates.

Example

This example splits blk-1 a distance of 2.0 from dom-1.  This results in two separate blocks.

Code

set domain [pw::Grid getByName "dom-1"]
set block [pw::Grid getByName "blk-1"]
set splits [$block splitByDistance 2.0 $domain]
puts "[llength $splits] blocks were created/modified."

Output

2 blocks were created/modified.

$block splitByFronts ?<-layers | -layerPerFront | -layerPerDomain>? value

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.  Blocks containing recombination data will be combined prior to splitting.

Parameters

Returns

This action returns a homogeneous list of pw::BlockUnstructured objects.

Information

This command supports progress updates.

Example

This example splits the unstructured TRex block at two fronts.  Both fronts are split at different TRex layer numbers.

Code

set block [pw::Grid getByName "blk-1"]
set splits [$block split splitByFront -layerPerFront \
  [list [list 1 3] [list 2 4]]]
puts "[llength $splits] blocks were created/modified."

Output

3 blocks were created/modified.

$block getInitializationError ?-points? index

This action gets a specific error message from the last initialization attempt.

Parameters

Returns

This action returns a list consisting of an error message string and 0 or more additional elements that are lists of vertices that indicate the location of the error.  Each list will contain vertex indices or xyz vectors if the -points parameter is present.

Information

Each list of vertices that indicate the location of the error represents a different shape depending on the number of vertices provided: a single point (1 vertex), an edge (2 vertices), a cell face (3 vertices), or a cell (4 vertices).

Do not depend on the actual error message strings as a “key”.  The message may change across releases or languages.

See Also

getInitializationErrorCount

$block getInitializationErrors

This action gets the error message list.

Parameters

This action has no parameters.

Returns

This action returns the list of string error messages.

See Also

getInitializationErrorCount

$blk getTRexCellCount

This action gets the number of T-Rex cells in the block.  Note that there is currently no distinction between an isotropic or anisotropic (T-Rex) cell, so this action is used only for statistical purposes.

Parameters

none

Returns

This action returns the number of anisotropic (T-Rex) cells.

$blk getTRexTetCount

This action gets the number of T-Rex tet cells in the block.  Note that there is currently no distinction between an isotropic or anisotropic (T-Rex) cell, so this action is used only for statistical purposes.

Parameters

none

Returns

This action returns the number of anisotropic (T-Rex) tet cells.

$blk getTRexPyrCount

This action gets the number of T-Rex pyr cells in the block.  Note that there is currently no distinction between an isotropic or anisotropic (T-Rex) cell, so this action is used only for statistical purposes.

Parameters

none

Returns

This action returns the number of anisotropic (T-Rex) pyramid cells.

$blk getTRexPrismCount

This action gets the number of T-Rex prism cells in the block.  Note that there is currently no distinction between an isotropic or anisotropic (T-Rex) cell, so this action is used only for statistical purposes.

Parameters

none

Returns

This action returns the number of anisotropic (T-Rex) prism cells.

$blk getTRexHexCount

This action gets the number of T-Rex hex cells in the block.  Note that there is currently no distinction between an isotropic or anisotropic (T-Rex) cell, so this action is used only for statistical purposes.

Parameters

none

Returns

This action returns the number of anisotropic (T-Rex) hex cells.

$blk getVoxelTetRange

This action returns the first and last tet in the array that were formed from voxel cells.

Parameters

none

Returns

A list of the first and last tetrahedral cell in the block that correspond to voxel tetrahedral cells.  If there are no voxel tetrahedra, 0 will be returned for each of these values.

Example

This example shows how to determine the range of tet cells in the block that were formed from voxel cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getVoxelTetRange]

Output

[1000 4500]

$blk getVoxelPyrRange

This action returns the first and last pyramid in the array that were formed from voxel cells.

Parameters

none

Returns

This action returns a list of the first and last pyramid in the block that correspond to voxel pyramids.  If there are no voxel pyramids, 0 will be returned for each of these values.

Example

This example shows how to determine the range of pyramid cells in the block that were formed from voxel cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getVoxelPyrRange]

Output

[1500 8520]

$blk getVoxelPrismRange

This action returns the first and last prism in the array that were formed from voxel cells.

Parameters

none

Returns

This action returns a list of the first and last prism in the block that correspond to voxel prisms.  If there are no voxel prisms, 0 will be returned for each of these values.

Example

This example shows how to determine the range of prism cells in the block that were formed from voxel cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getVoxelPrismRange]

Output

[3250 10500]

$blk getVoxelHexRange

This action returns the first and last hex in the array that were formed from voxel cells.

Parameters

none

Returns

This action returns a list of the first and last hex in the block that correspond to voxel hexes.  If there are no voxel hexes, 0 will be returned for each of these values.

Example

This example shows how to determine the range of hex cells in the block that were formed from voxel cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getVoxelHexRange]

Output

[5000 7500]

$blk getIsoTetRange

This action returns the first and last tet in the array that were formed from voxel cells.

Parameters

none

Returns

This action returns a list of the first and last tet in the block that correspond to isotropic tets.  If there are no iso tets, 0 will be returned for each of these values.

Example

This example shows how to determine the range of tet cells in the block that were formed from isotropic cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getIsoTetRange]

Output

[1000 4500]

$blk getIsoPyrRange

This action returns the first and last pyramid in the array that were formed from isotropic cells.

Parameters

none

Returns

This action returns a list of the first and last pyramid in the block that correspond to isotropic pyramids.  If there are no iso pyramids, 0 will be returned for each of these values.

Example

This example shows how to determine the range of pyramid cells in the block that were formed from iso cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getIsoPyrRange]

Output

[1500 8520]

$blk getIsoPrismRange

This action returns the first and last prism in the array that were formed from isotropic cells.

Parameters

none

Returns

This action returns a list of the first and last prism in the block that correspond to isotropic prisms.  If there are no iso prisms, 0 will be returned for each of these values.

Example

This example shows how to determine the range of prism cells in the block that were formed from isotropic cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getIsoPrismRange]

Output

[3250 10500]

$blk getIsoHexRange

This action returns the first and last hex in the array that were formed from isotropic cells.

Parameters

none

Returns

This action returns a list of the first and last hex in the block that correspond to isotropic hexes.  If there are no iso hexes, 0 will be returned for each of these values.

Example

This example shows how to determine the range of hex cells in the block that were formed from iso cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getIsoHexRange]

Output

[5000 7500]

$blk getAnisoTetRange

This action returns the first and last tet in the array that were formed from voxel cells.

Parameters

none

Returns

This action returns a list of the first and last tet in the block that correspond to anisotropic tets.  If there are no aniso tets, 0 will be returned for each of these values.

Example

This example shows how to determine the range of tet cells in the block that were formed from anisotropic cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getAnisoTetRange]

Output

[1000 4500]

$blk getAnisoPyrRange

This action returns the first and last pyramid in the array that were formed from anisotropic cells.

Parameters

none

Returns

This action returns a list of the first and last pyramid in the block that correspond to anisotropic pyramids.  If there are no aniso pyramids, 0 will be returned for each of these values.

Example

This example shows how to determine the range of pyramid cells in the block that were formed from aniso cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getAnisoPyrRange]

Output

[1500 8520]

$blk getAnisoPrismRange

This action returns the first and last prism in the array that were formed from anisotropic cells.

Parameters

none

Returns

This action returns a list of the first and last prism in the block that correspond to anisotropic prisms.  If there are no aniso prisms, 0 will be returned for each of these values.

Example

This example shows how to determine the range of prism cells in the block that were formed from anisotropic cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getAnisoPrismRange]

Output

[3250 10500]

$blk getAnisoHexRange

This action returns the first and last hex in the array that were formed from anisotropic cells.

Parameters

none

Returns

This action returns a list of the first and last hex in the block that correspond to anisotropic hexes.  If there are no aniso hexes, 0 will be returned for each of these values.

Example

This example shows how to determine the range of hex cells in the block that were formed from aniso cells.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getAnisoHexRange]

Output

[5000 7500]

$blk getTRexFullLayerCount

This action gets the number of T-Rex full layers in the block generated by the last run of the solver.  This may be different than the user-specified amount in the solver attributes

Parameters

none

Returns

This action returns the number of T-Rex full layers.

$blk getTRexTotalLayerCount

This action gets the number of T-Rex total layers in the block generated by the last run of the solver.  This may be different than the user-specified amount in the solver attributes

Parameters

none

Returns

This action returns the number of T-Rex total layers.

$blk getTRexTotalLayerHeight

This action gets the non-dimensional summed height of a TRex front at a specified layer.  It is non-dimensional in that the value will need to be multiplied by the initial wall spacing in order to represent the true approximate distance a front vertex lies from its surface position.  Total height is computed from the current growthRates assigned to the block.

Parameters

Returns

This action returns the non-dimensional height of a TRex front at the specified layer.

$blk getTRexMatchDomainCount ?-connectorCount connectorCountVar?

This action gets the number of match domains emanating from the adjacent grid/wall BC conditions within this block.

Parameters

Returns

This action returns the number of domains.

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

Parameters

none

Returns

This action returns a list of the minimum, average, and maximum of the initial spacings.  If there are no match domains, 0.0 will be returned for each of these values

Example

This example shows how to get the initial spacing on match domains from an unstructured block.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getTRexMatchInitialSpacing]

Output

[0.0100 0.0123 0.0200]

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

Parameters

none

Returns

This action returns a list of the minimum, average, and maximum of the growth rates.  If there are no match domains, 0.0 will be returned for each of these values

Example

This example shows how to get the average growth rate on match domains from an unstructured block.  $blk(1) is referencing an existing block.

Code

puts [$blk(1) getTRexMatchGrowthRate]

Output

[1.0100 1.0123 1.0200]

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

Parameters

none

Returns

This action returns a list of the minimum, average, and maximum of the layer counts.  If there are no match domains, 0.0 will be returned for each of these values

Example

This example shows how to get the average initial spacing on match domains from an unstructured block.  $blk(1) is referencing an existing domain.

Code

puts [$blk(1) getTRexMatchLayerCount]

Output

[10.0 20.0 30.0]

$block join block

This action joins the given block to this block.

Parameters

Returns

This action returns nothing.

$block freeInterior

This action frees the block’s interior points.

Parameters

This action has no parameters.

Returns

This action returns nothing.

$block pushAttributes

This action pushes the block’s attributes onto the match domains if the TRexPushAttributes attribute is true.  This normally occurs automatically during block initialization, but this action allows the attributes to be pushed without initializing the interior of the block.

Parameters

This action has no parameters.

Returns

This action returns nothing.

$block boundaryAdaptation

This action adapts the block’s boundaries based on the current settings of the block.  This normally occurs automatically during block initialization, but this action allows the adaptation to occur without initializing the interior of the block.

Parameters

This action has no parameters.

Returns

This action returns nothing.

$block removeFace face

This action removes a face from the block.

Parameters

Returns

This action returns nothing.

Information

If this is performed inside of a mode, the pw::FaceUnstructured object will be valid until the end of the mode.  Otherwise, the face object is deleted immediately.  The outer face of a block can not be removed unless it is the only face.

$block getOuterFace

This action returns the block’s outer face.

Parameters

none

Returns

This action returns a pw::FaceUnstructured object representing the block’s outer face.  An error is raised if the block does not have an outer face.

$block getBoundaryEdgeMinimumLength

This action gets the calculated minimum boundary edge length based on triangular area of the boundary cells.

Parameters

This action has no parameters.

Returns

This action returns the minimum boundary edge length as a float.

$block getBoundaryEdgeMaximumLength

This action gets the calculated maximum boundary edge length based on triangular area of the boundary cells.

Parameters

This action has no parameters.

Returns

This action returns the maximum boundary edge length as a float.

$block getVolumeEdgeMinimumLength

This action gets the calculated minimum volume edge length based on tetrahedral volume of the cells.

Parameters

This action has no parameters.

Returns

This action returns the minimum volume edge length as a float.

$block getVolumeEdgeMaximumLength

This action gets the calculated maximum volume edge length based on tetrahedral volume of the cells.

Parameters

This action has no parameters.

Returns

This action returns the maximum volume edge length as a float.

$block getPyramidBaseMaximumHeight

This action gets the calculated maximum height of the pyramids based on the prescribed aspect ratio and the base area of the cells.

Parameters

This action has no parameters.

Returns

This action returns the maximum pyramid height as a float.

This action gets the calculated minimum height of the pyramids based on the prescribed aspect ratio and the base area of the cells.

Parameters

This action has no parameters.

Returns

This action returns the minimum pyramid height as a float.

$block getAutomaticVoxelMinimumSize

This action gets the automatic minimum size used when the VoxelMinimumSize attribute is set to 0.0.

Parameters

This action has no parameters.

Returns

This action returns the automatic minimum voxel size as a float.

$block getAutomaticVoxelMaximumSize

This action gets the automatic maximum size used when the VoxelMinimumSize parameter is set to 0.0.

Parameters

This action has no parameters.

Returns

This action returns the automatic maximum size as a float.

$block getUnstructuredSolverAttribute att_name ?value_type?

This action gets the named unstructured solver attribute.

Parameters

Returns

This action returns the actual or default value of the named attribute.

See Also

setUnstructuredSolverAttribute, Unstructured Solver Attributes

$block setUnstructuredSolverAttribute att_name att_value

This action sets the named unstructured solver attribute.

Parameters

Returns

This action returns nothing.

See Also

getUnstructuredSolverAttribute, Unstructured Solver Attributes

$block get/setUnstructuredSolverAttribute BoundaryDecay decay

This attribute is the boundary decay factor of an unstructured block.  This attribute is being replaced by pw::GridEntity.SizeFieldDecay and will be deprecated soon.  Getting or setting this attribute is the same as getting or setting the pw::GridEntity.SizeFieldDecay attribute.

Type

A float in the range [0, 1].

Default

The default for this attribute is set using the current value of BoundaryDecay (Default).

See Also

BoundaryDecay (Default)

$block get/setUnstructuredSolverAttribute BackgroundSpacing spacing

This attribute is the background spacing of an unstructured block.  This attribute is being replaced by pw::GridEntity.SizeFieldBackgroundSpacing and will be deprecated soon.  Getting or setting this attribute is the same as getting or setting the pw::GridEntity.SizeFieldBackgroundSpacing attribute.

Type

A float in the range [0, infinity).

Default

The default for this attribute is set using the current value of the default BackgroundSpacing (Default).

See Also

BackgroundSpacing (Default)

$block get/setUnstructuredSolverAttribute EdgeMaximumGrowthRate growth_rate

This attribute is the maximum spacing growth rate along an edge of an unstructured block.

Type

A float in the range (1.0, infinity).

Default

The default for this attribute is 1.8.

See Also

EdgeMaximumGrowthRate (Default)

$block get/setUnstructuredSolverAttribute EdgeMaximumLength < Boundary | length >

This attribute is the maximum edge length of an unstructured block.

Type

A string with the value < Boundary > or a float in the range [0, infinity), where 0.0 indicates no maximum edge length.  Boundary indicates that the maximum edge length is derived from the block’s pw::Domain boundaries.

Default

The default for this attribute is 0.0.

See Also

EdgeMaximumLength (Default)

$block get/setUnstructuredSolverAttribute EdgeMinimumLength < Boundary | length >

This attribute is the minimum edge length of an unstructured block.

Type

A string with the value < Boundary > or a float in the range [0.0, infinity), where Boundary indicates to use the minimum edge length from the block’s pw::Domain boundaries.

Default

The default for this attribute is 0.0.

See Also

EdgeMinimumLength (Default)

$block get/setUnstructuredSolverAttribute InteriorAlgorithm algorithm

This attribute is the algorithm that will be used when initializing the interior portion of an unstructured block.

Type

A string with options < Delaunay | Voxel >.

Default

The default value is Delaunay.

See Also

InteriorAlgorithm (Default)

$block get/setUnstructuredSolverAttribute PyramidMaximumHeight height

The maximum pyramid height of an unstructured block

Type

A float in the range [0, infinity), where 0.0 means unrestricted pyramid height.

Default

The default for this attribute is 0.0.

See Also

PyramidMaximumHeight (Default)

$block get/setUnstructuredSolverAttribute PyramidMinimumHeight height

This attribute is the minimum pyramid height of an unstructured block.

Type

A float in the range [0, infinity), where 0.0 indicates unrestricted pyramid height.

Default

The default for this attribute is 0.0.

See Also

PyramidMinimumHeight (Default)

$block get/setUnstructuredSolverAttribute PyramidAspectRatio ratio

This attribute is the pyramid aspect ratio of an unstructured block.

Type

A float in the range (0, infinity).

Default

The default for this attribute is 0.5.

See Also

PyramidAspectRatio (Default)

$block get/setUnstructuredSolverAttribute TRexCellType value

This attribute controls what type of cells a T-Rex generated block will contain after generation.

Type

A string with options < TetPyramid | TetPyramidPrismHex | AllAndReducePyramids | LegacyTetPyramidPrismHex | AllAndConvertWallDoms >

Default

The default for this attribute is TetPyramidPrismHex

Information

TetPyramid indicates that generated cells will be stored as tets upon completion, except for pyramids necessarily placed adjacent to surface quads.

TetPyramidPrismHex means that a combination of tets, pyramids and prisms will be generated in the anisotropic (T-Rex) portion of the mesh.  In addition, hexes will be generated off of surface quads.

AllAndReducePyramids is the same as TetPyramidPrismHex except that a pyramid will be placed on the top of every stack of hexes whenever possible.  This pyramid replaces the 7 cell elements (a base pyramid, 4 side pyramids and 2 top tets) otherwise used to transition from a quad face to triangles faces touching the isotropic tet cells.  This technique will generally reduce the pyramid count in a mesh significantly when the T-Rex layers stop short of their isotropic height.

LegacyTetPyramidPrismHex (Glyph only) will have nearly the same results as TetPyramidPrismHex, but T-Rex will proceed with it’s slower pre-V18.1 algorithm, representing each hex with 4 (rather than 2) triangles until a satisfactory transition cell is achieved.

AllAndConvertWallDoms (Glyph only) is the same as TetPyramidPrismHex except that triangles lying on growth surfaces will be combined into quads (as is practical) after the block is generated.  This will essentially combine prism stacks into hex stacks, further lowering the cell count.

See Also

TRexCellType (Default)

$block get/setUnstructuredSolverAttribute TRexMaximumLayers value

This attribute is the maximum number of TRex layers of the block.

Type

An integer in the range [0, infinity), where 0 means that there should be no TRex layers.

Default

The default of this attribute is 0.

See Also

TRexMaximumLayers (Default)

$block get/setUnstructuredSolverAttribute TRexFullLayers value

This attribute is the minimum number of fully structured TRex layers of the block.

Type

An integer in the range [0, infinity), where 0 means that there should be no minimum fully structured TRex layers.

Default

The default of this attribute is 0.

See Also

TRexFullLayers (Default)

$block get/setUnstructuredSolverAttribute TRexGrowthRate value

This attribute is the growth rate of TRex layers for the block.

Type

A float in the range [1.0, infinity).

Default

The default for this attribute is 1.2.

See Also

TRexGrowthRate (Default)

$block get/setUnstructuredSolverAttribute TRexPushAttributes value

This attribute is the flag for pushing TRex attributes onto the connectors and domains of this block.

Type

A boolean, where true means that TRex attributes (initial spacing and growth rate or schedule) are pushed down onto the connectors and domains.

Default

The default value of this attribute is false.

See Also

TRexPushAttributes (Default)

$block get/setUnstructuredSolverAttribute TRexSpacingSmoothing value

This attribute is the number of smoothing sweeps to apply to the initial spacing values of TRex layers of the block.

Type

An integer in the range [0, infinity), where 0 means no smoothing is applied to the initial spacing values.

Default

The default of this attribute is 3.

See Also

TRexSpacingSmoothing (Default)

$block get/setUnstructuredSolverAttribute TRexSpacingRelaxationFactor value

This attribute is the relaxation factor of smoothing sweeps to apply to the initial spacing values of TRex layers for the block.

Type

A float in the range [0.0, 1.0), where 0 means no smoothing is applied to the initial spacing values.

Default

The default of this attribute is 0.7.

See Also

TRexSpacingRelaxationFactor (Default)

$block get/setUnstructuredSolverAttribute TRexIsotropicSeedLayers value

This attribute is the number of TRex isotropic seed layers for the block.

Type

A string with the value < UseRemainingLayers > or an explicit integer in the range [0, infinity), where 0 means that there should be no TRex isotropic seed layers.

Default

The default value of this attribute is 0.

See Also

TRexIsotropicSeedLayers (Default)

$block get/setUnstructuredSolverAttribute TRexLayerSubdivisions value

This attribute is the maximum cell height multiplier to be applied at the beginning of each T-Rex layer.  At layer completion, cells will be split into multiple layers, thereby accelerating the T-Rex process substantially.  The multiple specified will be the maximum number of possible layer splits, but the actual number could be less based on the cell height proximity to isotropy.

Type

An integer in the range [1, 10].

Default

The default value is 1 (no layer multiple).

$block get/setUnstructuredSolverAttribute TRexCollisionBuffer value

This attribute specifies the minimum buffer to be maintained between encroaching extruded tetrahedron.

Type

A float in the range [0, infinity).

Default

The default of this attribute is 0.5.

Info

This attribute is a multiplication factor of the current cell height.  With a factor of 0.5, a grid point will be extruded by a distance of 0.01 only if it may also be extruded by a distance of 0.015 without intersecting any other portion of the front.

See Also

TRexCollisionBuffer (Default)

$block get/setUnstructuredSolverAttribute TRexAnisotropicIsotropicBlend value

This attribute specifies the rate at which anisotropic triangles are blended into isotropic triangles on the block interior.

Type

A float in the range [0, 1], where 0 disables blending and larger values increase the rate of blending.

Default

The default of this attribute is 0.5.

See Also

TRexAnisotropicIsotropicBlend (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaDelayLayers value

This attribute is the number of layers to delay checking for the quality criteria of the TRex cells.

Type

An integer in the range [0, infinity), where 0 means that there should be no delay in checking the quality criteria.

Default

The default of this attribute is 0.

See Also

TRexSkewCriteriaDelayLayers (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaMaximumAngle value

This attribute specifies the maximum included angle quality threshold for TRex cells.  If the criterion cannot be met the cell will be discarded and the front is stopped locally.

Type

A float in the range [60.0, 180.0], where 180.0 disables the quality check.

Default

The default of this attribute is 180.0.

See Also

TRexSkewCriteriaMaximumAngle (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaEquivolume value

This attribute specifies the maximum equivolume quality threshold for TRex cells.  If the criterion cannot be met the cell will be discarded and the front is stopped locally.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default of this attribute is 1.0.

See Also

TRexSkewCriteriaEquivolume (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaEquiangle value

This attribute specifies the maximum equiangle quality threshold for TRex cells.  If the criterion cannot be met the cell will be discarded and the front is stopped locally.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default of this attribute is 1.0.

See Also

TRexSkewCriteriaEquiangle (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaCentroid value

This attribute specifies the maximum centroid skew quality threshold for TRex cells.  If the criterion cannot be met the cell will be discarded and the front is stopped locally.

Type

A float in the range [0.0, 1.0], where 1.0 disables the quality check.

Default

The default of this attribute is 1.0.

See Also

TRexSkewCriteriaCentroid (Default)

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaMinimumAngle value

This attribute specifies the minimum included angle quality threshold for TRex cells.  If the criterion cannot be met the cell will be discarded and the front is stopped locally.

Type

A float in the range [0.0, 60.0], where 0.0 disables the quality check.

Default

The default value of this attribute is 0.0.

$block get/setUnstructuredSolverAttribute TRexSkewCriteriaApplyToHexTrans value

This attribute determines whether T-Rex pyramid caps and transition hex cells will be tested against the user-set quality thresholds.

Type

A boolean, where false means that user-set TRex cell quality thresholds (other than positive volume checks) will not be applied to pyramid caps and transition hexes at the top of hex stacks.  Note that when true, failing quality of pyramid caps and transition hexes may cause the hex stack to be split into prism stacks.

Default

The default value is true.

See Also

TRexSkewCriteriaApplyToHexTrans (Default)

$block get/setUnstructuredSolverAttribute TRexIsotropicHeight value

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.

When set to 1.0, anisotropic cell growth continues at each vertex until one of the tets below the vertex reaches its isotropic height.  When a value other that 1.0 is selected, the isotropic height criteria is multiplied by the value, meaning that it is possible to stop vertex advancement prior (value < 1.0) or beyond (value > 1.0) true isotropy.

Type

A float in the range (0.0, infinity).

Default

The default of this attribute is 1.0.

See Also

TRexIsotropicHeight (Default)

$block get/setUnstructuredSolverAttribute TRexVolumeFunction function

This attribute specifies the method to be used when computing prism cell volumes for TRex cells.

Type

A string with options < MinComponent | GreenGauss >.  MinComponent indicates that the TRex mesher should use the minimum component volume for prism volume computation.  GreenGauss indicates the use of the Green-Gauss method of prism volume computation.

Default

The default of this attribute is MinComponent.

See Also

TRexVolumeFunction (Default)

$block get/setUnstructuredSolverAttribute TRexGrowthProfile profile

This attribute specifies the growth rate for each anisotropic layer.

Type

A list of float indicating the growth rate to apply at each layer in the anisotropic region of the block to compute the height of the next layer.  Each float in the list must be greater than zero.  If this attribute is specified as a non-empty list, the TRexGrowthRate attribute is ignored.  If the length of this list is less than the prescribed number of layers for the block, the last element is used as the growth rate for all subsequent layers.

Default

The default of this attribute is no growth profile, indicating that TRexGrowthRate be used for all layer height calculations.

$block get/setUnstructuredSolverAttribute OversetAdaptAmplification factor

This attribute is the adaption target edge length amplification factor of an unstructured block.

Type

A float in the range (0, infinity).

Default

The default for this attribute is 1.5.

See Also

OversetAdaptAmplification (Default)

$block get/setUnstructuredSolverAttribute OversetAdaptTargets <targets>

This attribute sets the orphan remediation and fringe improvement adaption targets to be applied to an unstructured block run in the unstructured solver.

Type

A list of string with values < Fringes | Donors | Orphans | OrphanDonorCandidates >.

Default

The default value is [list Donors OrphanDonorCandidates].

See Also

OversetAdaptTargets (Default)

$block get/setUnstructuredSolverAttribute VoxelAlignment alignment

This attribute represents the voxel alignment method to be used for an unstructured block when it is created.

Type

A string with options < Axes | Body >.

Default

The default value is Axes.

See Also

VoxelAlignment (Default)

$block get/setUnstructuredSolverAttribute VoxelMinimumSize size

This attribute is the minimum voxel size of the voxel mesh of this block.

Type

A float in the range [0, infinity).

Default

The default for this attribute is 0.0, which means to compute the minimum from either the size field (voxel blocks) or the block surface mesh (unstructured blocks).

See Also

VoxelMinimumSize (Default)

$block get/setUnstructuredSolverAttribute VoxelMaximumSize size

This attribute is the maximum voxel size of the voxel mesh of this block.

Type

A float in the range [0, infinity).

Default

The default for this attribute is 0.0, which means to compute the maximum as a fraction (1/8) of the shortest edge of the extents (voxel blocks), or the block surface mesh (unstructured blocks).

See Also

VoxelMaximumSize (Default)

$block get/setUnstructuredSolverAttribute VoxelTransitionLayers num

This attribute is the number of layers between voxel size transitions of the voxel mesh of this block.

Type

An integer in the range [1, 100].

Default

The default for this attribute is 3.

See Also

VoxelTransitionLayers (Default)

$block get/setUnstructuredSolverAttribute WCNSmoothConvergenceCostThreshold threshold

A cell is considered sufficiently “smoothed” if its cost value meets or exceeds this attribute’s value.

Type

A float in the range [0.0, 1.0].

Default

The default for this attribute is 0.8.

$block get/setUnstructuredSolverAttribute WCNSmoothCostAngleThreshold angle

Only cells with a cost angle above this limit are smoothed.

Type

A float in the range [0, 180).

Default

The default for this attribute is 175.

Notes

Cost angle is a more rigorous form of the max included angle calculation.  The cost angle is more sensitive to cells with warped quad faces.  The Cost angle and the max included angle values will be the same for tet cells (no quad faces) and for prism, pyramid, and hex cells whose quad faces are all planar.

$block get/setUnstructuredSolverAttribute WCNSmoothRelaxationFactor relaxation_factor

Only controls the magnitude of point smoothing movement per iteration.

Type

A float in the range (0, 0.5].

Default

The default for this attribute is 0.05.