Glyph Version 3.18.3 |
pw:: BlockUnstructuredUnstructured block type Derives Frompw::Object pw::Entity pw::GridEntity pw::Block Summary
create
This action creates a new unstructured block object. ParametersThis action has no parameters. ReturnsThis action returns a new pw::BlockUnstructured object. createFromDomains
This action creates new unstructured block objects from the given domains. Parameters
ReturnsThis 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). InformationThis command supports progress updates. NotesWhile 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. ExampleThis 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 Output Assembled a total of 3 blocks. createFromPoints
This action, given a list of <xyz> values and at least one cell-type array, creates a new unstructured block. ParametersThe 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.
ReturnsThis action returns the newly created block. ExampleThis example creates an unstructured block from a list of points and prism cell connectivity. Code set idim 5 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. Parameters
ReturnsThis action returns a heterogeneous list of the pw::BlockUnstructured and pw::BlockExtruded objects that were created and/or modified. InformationThis command supports progress updates. ExampleThis 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] Output 3 blocks were created/modified. join
This action joins as many of the given unstructured blocks together as possible. Parameters
ReturnsThis action returns a list of the pw::BlockUnstructured objects that were joined. InformationThis command supports progress updates. combineAnisoCells
This action combines anisotropic tet and pyramid cells in TRex-defined blocks into tet, pyramid, prism and hex cells. Parameters
ReturnsThis action returns nothing. InformationThis command supports progress updates. ExampleThis 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] BoundaryDecay
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. TypeThis default is a float with the range [0, 1]. DefaultThe default value is 0.5. BackgroundSpacing
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. TypeThis default is a float with the range (0, infinity). DefaultThe default value is 0.0. EdgeMaximumGrowthRate
This default is the maximum spacing growth rate along an edge of an unstructured block when it is created. TypeThis default is a float with the range (1.0, infinity). DefaultThe default value is 1.8. EdgeMaximumLength
This default is the maximum edge length of an unstructured block when it is created. TypeThis default is a float with the range (0, infinity). DefaultThe default value is Boundary. EdgeMinimumLength
This default is the minimum edge length of an unstructured block when it is created. TypeThis default is a float with the range (0, infinity). DefaultThe defualt value is Boundary. InteriorAlgorithm
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 TypeThis default is a string with options < Delaunay | Voxel >. DefaultThe default value is Delaunay. PyramidMaximumHeight
This default is the maximum pyramid height of an unstructured block when it is created. TypeThis default is a float with the range [0, infinity. Use 0 for unrestricted pyramid height. DefaultThe default value is 0. PyramidMinimumHeight
This default is the minimum pyramid height of an unstructured block when it is created. TypeThis default is a float with the range [0, infinity). Use 0 for unrestricted pyramid height. DefaultTHe default value is 0. PyramidAspectRatio
This default is the pyramid aspect ratio of an unstructured block when it is created. TypeThis default is a float with the range (0, infinity). DefaultTHe default value is 1. InitialMemorySize
This default is the initial memory size for initializing an unstructured block when it is created. More memory will be allocated if necessary. TypeThis default is an integer with the range 0 | [10, infinity) megabytes. DefaultThe default value is 0. TRexCellType
This default is the type of cells generated by TRex of an unstructured block when it is created. TypeThis default is a string with options < TetPyramid | TetPyramidPrismHex | AllAndReducePyramids | LegacyTetPyramidPrismHex | AllAndConvertWallDoms > DefaultThe default value is TetPyramidPrismHex InformationTetPyramid 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. TRexMaximumLayers
This default is the maximum number of T-Rex layers of an unstructured block when it is created. TypeThis default is an integer with the range [0, infinity), where 0 means that there should be no TRex layers. DefaultThe default value is 0. TRexFullLayers
This default is the minimum number of fully structured TRex layers of an unstructured block when it is created. TypeThis default is an integer with the range [0, infinity), where 0 means that there should be no minimum fully structured TRex layers. DefaultThe default value is 0. TRexGrowthRate
This default is the growth rate of TRex layers of an unstructured block when it is created. TypeThis default is a float with the range [1.0, infinity). DefaultThe default value is 1.3. TRexPushAttributes
This default is the flag for pushing TRex attributes onto the connectors and domains of an unstructured block when a it is created. TypeThis default is a boolean, where true means that TRex attributes are pushed down onto the connectors and domains. DefaultThe default value is false. TRexSpacingSmoothing
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. TypeThis default is an integer with the range [0, infinity), where 0 means no smoothing is applied to the initial spacing values. DefaultThe default value is 3. TRexSpacingRelaxationFactor
This default is the relaxation factor of smoothing sweeps to apply to the intial spacing values of TRex layers for an unstructured block when it is created. TypeThis default is a float with the range [0.0, 1.0), where 0 means no smoothing is applied to the initial spacing values. DefaultThe default value is 0.7. TRexIsotropicSeedLayers
This default is the number of TRex isotropic seed layers for an unstructured block when it is created. TypeThis default is a string with the value < UseRemainingLayers > or an explicit integer with the range [0, infinity), where 0 means that there should be no TRex isotropic seed layers. DefaultThe default value is 0. TRexCollisionBuffer
This default is the minimum buffer to be maintained between encroaching extruded tetrahedrals of an unstructured block when it is created. TypeThis default is a float with the range [0, infinity). DefaultThe default value is 0.5. InfoThis 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. TRexAnisotropicIsotropicBlend
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. TypeThis default is a float with the range [0, 1], where 0 disables blending and larger values increase the rate of blending. DefaultThe default value is 0.5. TRexIsotropicHeight
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. TypeThis default is a float with the range (0.0, infinity). DefaultThe default value is 1.0. TRexSkewCriteriaDelayLayers
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. TypeThis default is an integer with the range [0, infinity), where 0 means that there should be no delay in checking the quality criteria. DefaultThe default value is 0. TRexSkewCriteriaMaximumAngle
This default is the maximum included angle quality threshold for TRex cells of an unstructured block when it is created. TypeThis default is a float with the range [60.0, 180.0], where 180.0 disables the quality check. DefaultThe default value is 180.0. TRexSkewCriteriaEquivolume
This default is the maximum equivolume quality threshold for TRex cells of an unstructured block when it is created. TypeThis default is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default value is 1.0. TRexSkewCriteriaEquiangle
This default is the maximum equiangle quality threshold for TRex cells of an unstructured block when it is created. TypeThis default is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default value is 1.0. TRexSkewCriteriaCentroid
This default is the maximum centroid skew quality threshold for TRex cells of an unstructured block when it is created. TypeThis default is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default value is 1.0. TRexVolumeFunction
This default is the method to be used when computing prism cell volumes for TRex cells of an unstructured block when it is created. TypeThis default is 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. DefaultThe default value is MinComponent. OversetAdaptAmplification
This default is the adaption target edge length amplification factor of an unstructured block when it is created. TypeThis default is a float with the range (0, infinity). DefaultThe default value is 1.5. OversetAdaptTargets
This default is the orphan remediation and fringe improvement adaption targets of an unstructured block when it is created. TypeThis default is a list of strings with values < Fringes | Donors | Orphans | OrphanDonorCandidates >. DefaultThe default value is [list Donors OrphanDonorCandidates]. VoxelAlignment
This default represents the voxel alignment method to be used for an unstructured block when it is created. TypeThis default is a string with options < Axes | Body >. DefaultThe default value is Axes. VoxelMinimumSize
This default is the minimum voxel size of the voxel mesh of an unstructured block when it is created. TypeThis default is a float with the range [0, infinity). DefaultThe 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). VoxelMaximumSize
This default is the maximum voxel size of the voxel mesh of an unstructured block when it is created. TypeThis default is a float with the range [0, infinity). DefaultThe 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). VoxelTransitionLayers
This default is the number of layers between voxel size transitions of the voxel mesh of an unstructured block when it is created. TypeThis default is an integer with the range [1, 100]. DefaultThe default for this attribute is 1. getInitializationErrorCount
This action gets the number of errors from the last attempt at initializing the block. ParametersThis action has no parameters. ReturnsThis action returns the integer number of error messages. getTRexFront
This action takes an input list of domains on the block and determines which TRex fronts they lie on, if any. Parameters
ReturnsThis 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. ExampleThis 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"] Output Domains lie on fronts 2 3. getTRexLayersOnFront
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
ReturnsThis 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. splitByDistance
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
ReturnsThis action returns a homogenous list of pw::BlockUnstructured objects. InformationThis command supports progress updates. ExampleThis 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"] Output 2 blocks were created/modified. 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. Blocks containing recombination data will be combined prior to splitting. Parameters
ReturnsThis action returns a homogenous list of pw::BlockUnstructured objects. InformationThis command supports progress updates. ExampleThis 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"] Output 3 blocks were created/modified. getInitializationError
This action gets a specific error message from the last initialization attempt. Parameters
ReturnsThis 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. InformationEach 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 AlsogetInitializationErrors
This action gets the error message list. ParametersThis action has no parameters. ReturnsThis action returns the list of string error messages. See AlsogetTRexCellCount
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. Parametersnone ReturnsThis action returns the number of anisotropic (T-Rex) cells. 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. Parametersnone ReturnsThis action returns the number of anisotropic (T-Rex) tet cells. 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. Parametersnone ReturnsThis action returns the number of anisotropic (T-Rex) pyramid cells. 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. Parametersnone ReturnsThis action returns the number of anisotropic (T-Rex) prism cells. 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. Parametersnone ReturnsThis action returns the number of anisotropic (T-Rex) hex cells. 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 Parametersnone ReturnsThis action returns the number of T-Rex full layers. 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 Parametersnone ReturnsThis action returns the number of T-Rex total layers. 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
ReturnsThis action returns the non-dimensional height of a TRex front at the specified layer. getTRexMatchDomainCount
This action gets the number of match domains emanating from the adjacent grid/wall BC conditions within this block. Parameters
ReturnsThis action returns the number of domains. 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. Parametersnone ReturnsThis action returns a vector 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 ExampleThis 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] 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. Parametersnone ReturnsThis action returns a vector 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 ExampleThis 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] 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. Parametersnone ReturnsThis action returns a vector 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 ExampleThis 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] join
This action joins the given block to this block. Parameters
ReturnsThis action returns nothing. 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. ParametersThis action has no paramteres. ReturnsThis action returns nothing. 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. ParametersThis action has no paramteres. ReturnsThis action returns nothing. removeFace
This action removes a face from the block. Parameters
ReturnsThis action returns nothing. InformationIf 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. getOuterFace
This action returns the block’s outer face. Parametersnone ReturnsThis 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. getBoundaryEdgeMinimumLength
This action gets the calculated minimum boundary edge length based on triangluar area of the boundary cells. ParametersThis action has no parameters. ReturnsThis action returns the minimum boundary edge length as a float. getBoundaryEdgeMaximumLength
This action gets the calculated maximum boundary edge length based on triangluar area of the boundary cells. ParametersThis action has no parameters. ReturnsThis action returns the maximum boundary edge length as a float. getVolumeEdgeMinimumLength
This action gets the calculated minimum volume edge length based on tetrahedral volume of the cells. ParametersThis action has no parameters. ReturnsThis action returns the minimum volume edge length as a float. getVolumeEdgeMaximumLength
This action gets the calculated maximum volume edge length based on tetrahedral volume of the cells. ParametersThis action has no parameters. ReturnsThis action returns the maximum volume edge length as a float. getPyramidBaseMaximumHeight
This action gets the calculated maximum height of the pyrimds based on the proscribed aspect ratio and the base area of the cells. ParametersThis action has no parameters. ReturnsThis action returns the maximum pyramid height as a float. getPyramidBaseMinimumHeightThis action gets the calculated minimum height of the pyrimds based on the proscribed aspect ratio and the base area of the cells. ParametersThis action has no parameters. ReturnsThis action returns the minimum pyramid height as a float. getAutomaticVoxelMinimumSize
This action gets the automatic minimum size used when the VoxelMinimumSize parameter is set to 0.0. ParametersThis action has no parameters. ReturnsThis action returns the automatic minimum size as a float. getAutomaticVoxelMaximumSize
This action gets the automatic maximum size used when the VoxelMinimumSize parameter is set to 0.0. ParametersThis action has no parameters. ReturnsThis action returns the automatic maximum size as a float. getUnstructuredSolverAttribute
This action gets the named unstructured solver attribute. Parameters
ReturnsThis action returns the value of the attribute. setUnstructuredSolverAttribute
This action sets the named unstructured solver attribute. Parameters
ReturnsThis action returns nothing. BoundaryDecay
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. TypeThis attribute is a float with the range [0, 1]. DefaultThe default for this attribute is set using the current value of the default BoundaryDecay. BackgroundSpacing
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. TypeThis attribute is a float with the range [0, infinity). DefaultThe default for this attribute is set using the current value of the default BackgroundSpacing. EdgeMaximumGrowthRate
This attribute is the maximum spacing growth rate along an edge of an unstructured block. TypeThis attribute is a float with the range (1.0, infinity). DefaultThe default for this attribute is 1.8. EdgeMaximumLength
This attribute is the maximum edge length of an unstructured block. TypeThis attribute is a float with the range (0, infinity). DefaultThe default for this attribute is 0.0. EdgeMinimumLength
This attribute is the minimum edge length of an unstructured block. TypeThis attribute is a float with the range (0, infinity). DefaultThe default for this attribute is 0.0. InteriorAlgorithm
This attribute is the algorithm that will be used when initializing the interior portion of an unstructured block. TypeThis default is a string with options < Delaunay | Voxel >. DefaultThe default value is Delaunay. PyramidMaximumHeight
The maximum pyramid height of an unstructured block Typefloat; [0, infinity), use 0 for unrestricted pyramid height DefaultThe default for this attribute is 0.0. PyramidMinimumHeight
This attribute is the minimum pyramid height of an unstructured block. TypeThis attribute is a float with the range [0, infinity). Use 0 for unrestricted pyramid height. DefaultThe default for this attribute is 0.0. PyramidAspectRatio
This attribute is the pyramid aspect ratio of an unstructured block. TypeThis attribute is a float with the range (0, infinity). DefaultThe default for this attribute is 0.5. LegacyMode
This attribute determines which isotropic tetrahedral mesh solver is used to initialize an unstructured block. TypeThis attribute is a boolean, where true means to run in Legacy Mode. DefaultThe default for this attribute is 0. InitialMemorySize
This attribute is the initial memory allocated for initializing an unstructured block. TypeThis attribute is an integer with the range 0 | [10, infinity) in megabytes. DefaultThe default for this attribute is 0. IterationCount
This attribute is the number of iterations to be used for intializing the interior points of this block. TypeThis attribute is an integer with the range [1, 12]. DefaultThe default for this attribute is 1. TRexCellType
This attribute controls what type of cells a T-Rex generated block will contain after generation. TypeThis attribute is a string with options < TetPyramid | TetPyramidPrismHex | AllAndReducePyramids | LegacyTetPyramidPrismHex | AllAndConvertWallDoms > DefaultThe default for this attribute is TetPyramidPrismHex InformationTetPyramid 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. TRexMaximumLayers
This attribute is the maximum number of TRex layers of the block. TypeThis attribute is an integer with the range [0, infinity), where 0 means that there should be no TRex layers. DefaultThe default of this attribute is 0. TRexFullLayers
This attribute is the minimum number of fully structured TRex layers of the block. TypeThis attribute is an integer with the range [0, infinity), where 0 means that there should be no minimum fully structured TRex layers. DefaultThe default of this attribute is 0. TRexGrowthRate
This attribute is the growth rate of TRex layers for the block. TypeThis attribute is a float with the range [1.0, infinity). DefaultThe default of this attribute is 1.3. TRexPushAttributes
This attribute is the flag for pushing TRex attributes onto the connectors and domains of this block. TypeThis attribute is a boolean, where true means that TRex attributes are pushed down onto the connectors and domains. DefaultThe default of this attribute is false. TRexSpacingSmoothing
This attribute is the number of smoothing sweeps to apply to the initial spacing values of TRex layers of the block. TypeThis attribute is an integer with the range [0, infinity), where 0 means no smoothing is applied to the initial spacing values. DefaultThe default of this attribute is 3. TRexSpacingRelaxationFactor
This attribute is the relaxation factor of smoothing sweeps to apply to the intial spacing values of TRex layers for the block. TypeThis attribute is a float with the range [0.0, 1.0), where 0 means no smoothing is applied to the initial spacing values. DefaultThe default of this attribute is 0.7. TRexIsotropicSeedLayers
This attribute is the number of TRex isotropic seed layers for the block. TypeThis attribute is a string with the value < UseRemainingLayers > or an explicit integer with the range [0, infinity), where 0 means that there should be no TRex isotropic seed layers. DefaultThe default value of this attribute is 0. TRexCollisionBuffer
This attribute specifies the minimum buffer to be maintained between encroaching extruded tetrahedrals. TypeThis attribute is a float with the range [0, infinity). DefaultThe default of this attribute is 0.5. InfoThis 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. TRexAnisotropicIsotropicBlend
This attribute specifies the rate at which anisotropic triangles are blended into isotropic triangles on the block interior. TypeThis attribute is a float with the range [0, 1], where 0 disables blending and larger values increase the rate of blending. DefaultThe default of this attribute is 0.5. TRexSkewCriteriaDelayLayers
This attribute is the number of layers to delay checking for the quality criteria of the TRex cells. TypeThis attribute is an integer with the range [0, infinity), where 0 means that there should be no delay in checking the quality criteria. DefaultThe default of this attribute is 0. TRexSkewCriteriaMaximumAngle
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. TypeThis attribute is a float with the range [60.0, 180.0], where 180.0 disables the quality check. DefaultThe default of this attribute is 180.0. TRexSkewCriteriaEquivolume
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. TypeThis attribute is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default of this attribute is 1.0. TRexSkewCriteriaEquiangle
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. TypeThis attribute is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default of this attribute is 1.0. TRexSkewCriteriaCentroid
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. TypeThis attribute is a float with the range [0.0, 1.0], where 1.0 disables the quality check. DefaultThe default of this attribute is 1.0. TRexSkewCriteriaMinimumAngle
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. TypeThis attribute is a float with the range [0.0, 60.0], where 0.0 disables the quality check. DefaultThe default of this attribute is 0.0. 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. 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) or beyond (value> 1) true isotropy. TypeThis attribute is a float with the range (0.0, infinity) DefaultThe default of this attribute is 1.0. TRexTransitionHexMode
This deprecated attribute formerly specified how transition cells at the top of hex stacks were formed from quad surface elements in T-Rex. It now has no effect. TypeThis attribute is a string with options < LegacyMode | CapNone | CapFailed | CapAll >. LegacyMode is used to run T-Rex following the traditional V18.0 (slower) protocol. CapNone uses the more efficient 2 triangle front representation for quads, and attempts to form hex stacks at the completion of T-Rex. If TRexCellType is set to AllAndConvertWallDoms, hex stacks failing transition cell quality criteria will be split into 2 prism stacks. If TRexCellType is set to TetPyramidPrismHex, hex stacks failing transition cell quality criteria will be maintained as hexes. CapFailed is used to place a quality-compliant pyramid on top of the hex stack only when the transition cell fails the quality criteria. Pyramids will also attempt to be made isotropic-compliant, based on the user-specified min/max pyramid heights and aspect ratio attributes. Adding a cap pyramid usually prevents transition cells from failing the quality criteria, while leaving the transition cells on quality-compliant cells. CapAll is used to place a quality-compliant pyramid on top of all hex stacks, including those whose transition cells pass the quality criteria. This method minimizes the number of pyramids in the mesh by replacing most 5-pyr, 2-tet transition elements with a hex and a single pyramid. However, it also maximizes the number of pyramid triangles exposed on the isotropic front. Pyramids will also attempt to be made isotropic-compliant, based on the user-specified min/max pyramid heights and aspect ratio attributes. DefaultThe default of this attribute is LegacyMode. NotesIn V18.0, quads were represented on layer 1 as 4 triangles, with that representation continuing with advancing layers until it was possible to replace them with 2 triangles via a cell quality-compliant transition hex. With this method, the 4 triangle rep had a tendency to be maintained for many layers, particularly when aggressive maxAngle criteria was applied. The denser triangle front resulted in a slower algorithm. In V18.1, more efficient algorithmic options were added. Specifically, unstructured quads on layer 1 are now represented as 2 triangles, and 2 prism stacks are formed as layers are advanced. The 2-tri rep reduces the number of deformations by a factor of 2 (nominally), which increases efficiency. Upon completion of T-Rex, an attempt is made to join the prism stacks into hex stacks, with the top hex exploded into a transition hex. Whereas in V18.0 the transition hex was not formed until it passed the quality checks, in V18.1 the transition hex is automatically formed on the top of the stacks, even if the transition hex fails the criteria. In order to prevent poor cell quality, 3 options (< CapNone >, < CapFailed >, < CapAll >) are now offered. TRexVolumeFunction
This attribute specifies the method to be used when computing prism cell volumes for TRex cells. TypeThis attribute is a string with one of the values < MinComponent > or < GreenGauss >. MinComponent indicates that the TRex mesher should use the minimum component volume for prism volume computation. GreenGause indicates the use of the Green-Gauss method of prism volume computation. DefaultThe default of this attribute is MinComponent. TRexGrowthProfile
This attribute specifies the growth rate for each anisotropic layer. TypeThis attribute is 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 proscribed number of layers for the block, the last element is used as the growth rate for all subsequent layers. DefaultThe default of this attribute is no growth profile, indicating that TRexGrowthRate be used for all layer height calculations. OversetAdaptAmplification
This attribute is the adaption target edge length amplification factor of an unstructured block. TypeThis attribute is a float with the range (0, infinity). DefaultThe default for this attribute is 1.5. OversetAdaptTargets
This attribute sets the orphan remediation and fringe improvement adaption targets to be applied to an unstructured block run in the unstructured solver. TypeThis default is a list of strings with values < Fringes | Donors | Orphans | OrphanDonorCandidates >. DefaultThe default value is [list Donors OrphanDonorCandidates]. VoxelAlignment
This attribute represents the voxel alignment method to be used for an unstructured block when it is created. TypeThis default is a string with options < Axes | Body >. DefaultThe default value is Axes. VoxelMinimumSize
This attribute is the minimum voxel size of the voxel mesh of this block. TypeThis attribute is a float with the range [0, infinity). DefaultThe 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). VoxelMaximumSize
This attribute is the maximum voxel size of the voxel mesh of this block. TypeThis attribute is a float with the range [0, infinity). DefaultThe 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). VoxelTransitionLayers
This attribute is the number of layers between voxel size transitions of the voxel mesh of this block. TypeThis attribute is an integer with the range [1, 100]. DefaultThe default for this attribute is 3. |
This action creates a new unstructured block object.
pw::BlockUnstructured create
This action creates new unstructured block objects from the given domains.
pw::BlockUnstructured createFromDomains ?-reject rejectVar? ?-fillVoids? ?-voids voidsVar? ?-addBaffles? ?-baffles bafflesVar? domains
This action, given a list of xyz values and at least one cell-type array, creates a new unstructured block.
pw::BlockUnstructured createFromPoints ?-tetrahedrons tetCellArray? ?-pyramids pyramidCellArray? ?-prisms prismCellArray? ?-hexahedrons hexCellArray? ?-splitAngle angle? ?-splitMultiloop? points
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.
pw::BlockUnstructured split ?<-trexLayers | -trexFronts>? blocks
This action joins as many of the given unstructured blocks together as possible.
pw::BlockUnstructured join ?-reject rejectVar? blocks
This action combines anisotropic tet and pyramid cells in TRex-defined blocks into tet, pyramid, prism and hex cells.
pw::BlockUnstructured combineAnisoCells blocks
This default is the boundary decay factor of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault BoundaryDecay decay
This default is the background grid spacing of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault BackgroundSpacing spacing
This default is the maximum spacing growth rate along an edge of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault EdgeMaximumGrowthRate growth_rate
This default is the maximum edge length of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault EdgeMaximumLength < Boundary | length >
This default is the minimum edge length of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault EdgeMinimumLength < Boundary | length >
This default is the algorithm that will be used when initializing the interior portion of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault InteriorAlgorithm algorithm
This default is the maximum pyramid height of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault PyramidMaximumHeight height
This default is the minimum pyramid height of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault PyramidMinimumHeight height
This default is the pyramid aspect ratio of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault PyramidAspectRatio ratio
This default is the initial memory size for initializing an unstructured block when it is created.
pw::BlockUnstructured get/setDefault InitialMemorySize megabytes
This default is the type of cells generated by TRex of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexCellType value
This default is the maximum number of T-Rex layers of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexMaximumLayers layers
This default is the minimum number of fully structured TRex layers of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexFullLayers layers
This default is the growth rate of TRex layers of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexGrowthRate growth_rate
This default is the flag for pushing TRex attributes onto the connectors and domains of an unstructured block when a it is created.
pw::BlockUnstructured get/setDefault TRexPushAttributes push
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.
pw::BlockUnstructured get/setDefault TRexSpacingSmoothing smooth
This default is the relaxation factor of smoothing sweeps to apply to the intial spacing values of TRex layers for an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexSpacingRelaxationFactor factor
This default is the number of TRex isotropic seed layers for an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexIsotropicSeedLayers value
This default is the minimum buffer to be maintained between encroaching extruded tetrahedrals of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexCollisionBuffer factor
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.
pw::BlockUnstructured get/setDefault TRexAnisotropicIsotropicBlend blending
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.
pw::BlockUnstructured get/setDefault TRexIsotropicHeight isoHeight
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.
pw::BlockUnstructured get/setDefault TRexSkewCriteriaDelayLayers delay
This default is the maximum included angle quality threshold for TRex cells of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexSkewCriteriaMaximumAngle angle
This default is the maximum equivolume quality threshold for TRex cells of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexSkewCriteriaEquivolume threshold
This default is the maximum equiangle quality threshold for TRex cells of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexSkewCriteriaEquiangle threshold
This default is the maximum centroid skew quality threshold for TRex cells of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexSkewCriteriaCentroid threshold
This default is the method to be used when computing prism cell volumes for TRex cells of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault TRexVolumeFunction function
This default is the adaption target edge length amplification factor of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault OversetAdaptAmplification factor
This default is the orphan remediation and fringe improvement adaption targets of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault OversetAdaptTargets targets
This default represents the voxel alignment method to be used for an unstructured block when it is created.
pw::BlockUnstructured get/setDefault VoxelAlignment alignment
This default is the minimum voxel size of the voxel mesh of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault VoxelMinimumSize size
This default is the maximum voxel size of the voxel mesh of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault VoxelMaximumSize size
This default is the number of layers between voxel size transitions of the voxel mesh of an unstructured block when it is created.
pw::BlockUnstructured get/setDefault VoxelTransitionLayers num
This action gets the number of errors from the last attempt at initializing the block.
$block getInitializationErrorCount
This action takes an input list of domains on the block and determines which TRex fronts they lie on, if any.
$block getTRexFront domain
This action takes a list of front ids and determines how many full and max layers are associated with the front.
$block getTRexLayersOnFront fronts
This action splits the unstructured block into a number of new blocks based on a distance from specified domains within the block.
$block splitByDistance distance domains
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.
$block splitByFronts ?<-layers | -layerPerFront | -layerPerDomain>? value
This action gets a specific error message from the last initialization attempt.
$block getInitializationError ?-points? index
This action gets the error message list.
$block getInitializationErrors
This action gets the number of T-Rex cells in the block.
$blk getTRexCellCount
This action gets the number of T-Rex tet cells in the block.
$blk getTRexTetCount
This action gets the number of T-Rex pyr cells in the block.
$blk getTRexPyrCount
This action gets the number of T-Rex prism cells in the block.
$blk getTRexPrismCount
This action gets the number of T-Rex hex cells in the block.
$blk getTRexHexCount
This action gets the number of T-Rex full layers in the block generated by the last run of the solver.
$blk getTRexFullLayerCount
This action gets the number of T-Rex total layers in the block generated by the last run of the solver.
$blk getTRexTotalLayerCount
This action gets the non-dimensional summed height of a TRex front at a specified layer.
$blk getTRexTotalLayerHeight
This action gets the number of match domains emanating from the adjacent grid/wall BC conditions within this block.
$blk getTRexMatchDomainCount ?-connectorCount connectorCountVar?
This action gets the minimum, average, and maximum initial spacing of the match domains connected to the adj grid/wall BCs of this block.
$blk getTRexMatchInitialSpacing
This action gets the minimum, average, and maximum growth rates of the match domains connected to the adj grid/wall BCs of this block.
$blk getTRexMatchGrowthRate
This action gets the minimum, average, and maximum layer count of the match domains connected to the adj grid/wall BCs of this block.
$blk getTRexMatchLayerCount
This action frees the block’s interior points.
$block freeInterior
This action pushes the block’s attributes onto the match domains if the TRexPushAttributes attribute is true.
$block pushAttributes
This action adapts the block’s boundaries based on the current settings of the block.
$block boundaryAdaptation
This action removes a face from the block.
$block removeFace $face
This action returns the block’s outer face.
$block getOuterFace
This action gets the calculated minimum boundary edge length based on triangluar area of the boundary cells.
$block getBoundaryEdgeMinimumLength
This action gets the calculated maximum boundary edge length based on triangluar area of the boundary cells.
$block getBoundaryEdgeMaximumLength
This action gets the calculated minimum volume edge length based on tetrahedral volume of the cells.
$block getVolumeEdgeMinimumLength
This action gets the calculated maximum volume edge length based on tetrahedral volume of the cells.
$block getVolumeEdgeMaximumLength
This action gets the calculated maximum height of the pyrimds based on the proscribed aspect ratio and the base area of the cells.
$block getPyramidBaseMaximumHeight
This action gets the automatic minimum size used when the VoxelMinimumSize parameter is set to 0.0.
$block getAutomaticVoxelMinimumSize
This action gets the automatic maximum size used when the VoxelMinimumSize parameter is set to 0.0.
$block getAutomaticVoxelMaximumSize
This action gets the named unstructured solver attribute.
$block getUnstructuredSolverAttribute att_name
This action sets the named unstructured solver attribute.
$block setUnstructuredSolverAttribute att_name att_value
This attribute determines which isotropic tetrahedral mesh solver is used to initialize an unstructured block.
$block get/setUnstructuredSolverAttribute LegacyMode value
This attribute is the number of iterations to be used for intializing the interior points of this block.
$block get/setUnstructuredSolverAttribute IterationCount count
This attribute specifies the minimum included angle quality threshold for TRex cells.
$block get/setUnstructuredSolverAttribute TRexSkewCriteriaMinimumAngle value
This deprecated attribute formerly specified how transition cells at the top of hex stacks were formed from quad surface elements in T-Rex.
// removed from Glyph doc // $block get/setUnstructuredSolverAttribute TRexTransitionHexMode function
This attribute specifies the growth rate for each anisotropic layer.
$block get/setUnstructuredSolverAttribute TRexGrowthProfile profile
This action creates a new unstructured face object.
pw::FaceUnstructured create
This action adds a domain to this face.
$face addDomain ?-linkage linkage? domain
This action adds a face to the block.
$block addFace face
This default is the size field decay factor of a grid entity when it is created.
pw::GridEntity get/setDefault SizeFieldDecay decay
This default is the size field background spacing of a grid entity when it is created.
pw::GridEntity get/setDefault SizeFieldBackgroundSpacing spacing