A structured domain is a computationally orthogonal surface grid bounded by exactly four edges, any of which can be degenerate in the zero dimension (pole).
pw::Object pw::Entity pw::GridEntity pw::Domain
| pw:: | A structured domain is a computationally orthogonal surface grid bounded by exactly four edges, any of which can be degenerate in the zero dimension (pole). |
| Static Actions | |
| create | This action creates a new structured domain object. |
| createOnDatabase | This action creates new structured domain objects on the given database entities. |
| createFromConnectors | This action creates new structured domain objects from the given connectors. |
| createFromPoints | This action, given a list of lists of xyz vector values or database-constrained points, creates a new domain. |
| join | This action joins as many of the given structured domains together as possible. |
| qualifyEdges | This action checks if a list of edges would be valid for defining a structured domain. |
| getOverlappingDomains | This action will get the domains that share corners with the edges passed in. |
| getAutoCompleteHint | This action is valid only when 2 or more edges have been defined, it returns a list of connectors that will complete the domain definition. |
| getDomainsFromDatabase | This action gets a list of domains that are constrained to the given databases. |
| getDomainSubGridsFromDatabase | This action gets a list of subgrids that are constrained to the given databases. |
| Static Defaults | |
| EdgeControl (Default) | This default is the boundary control function of all edges of a structured domain when it is created. |
| SolverEngine (Default) | This default is the elliptic solver engine employed when smoothing a structured domain. |
| Instance Actions | |
| getPoint | This action gets the position of a domain grid point. |
| setPoint | This action sets the position of a domain interior grid point. |
| isInteriorIndex | This action checks to see if an index corresponds to a point in the interior of the domain. |
| getLinearIndex | This converts a domain’s ij index to a integer linear index. |
| getPosition | This action gets the position in the defining space of the domain at the given index. |
| getXYZ | This action gets the position of the domain in model space at the given index. |
| getCell | This action gets the indices of the given cell. |
| getCellsUsingIndex | Returns the indices of the cells whose connectivity includes the specified index. |
| getXYZsAtIndex | This action gets a line of points in the given direction at the given index. |
| createSubGrid | This action creates a subgrid on this domain. |
| getSubGridCount | This action gets the number of subgrids in this domain. |
| getSubGrid | This action gets the subgrid at the given index. |
| getSubGrids | This action gets the subgrid list. |
| removeSubGrid | This action removes the subgrid from the domain. |
| getEllipticSolverResidual | This action gets the last elliptic solver residual info for the domain/subgrid at the given index. |
| getEdge | This action gets the edge at the given index or computational boundary. |
| project | This action projects this domain onto one or more database entities. |
| split | This action splits this domain in the given direction at the given indices. |
| join | This action joins the given domain to this domain. |
| setOrientation | This action sets the orientation of this domain, by specifying the imin and jmin edges of the domain. |
| alignOrientation | This action aligns the IJK orientation of the given domains with this domain. |
| canReExtrude | This action returns true if the entity can be re-extruded. |
| triangulate | This action creates an unstructured domain by triangulating this domain. |
| getInitializeMethod | This action gets the initialization method for this domain. |
| setInitializeMethod | This action sets the initialization method for this domain. |
| getEllipticSolverAttribute | This action gets the named elliptic solver attribute. |
| setEllipticSolverAttribute | This action sets the named elliptic solver attribute. |
| setExtrusionSolverAttribute | This action sets the named extrusion solver attribute. |
| getExtrusionBoundaryCondition | This action gets the boundary condition at a given edge side. |
| setExtrusionBoundaryCondition | This action sets the boundary condition at a given connector region. |
| getExtrusionBoundaryConditionStepSuppression | This action gets the step suppression factor applied to the boundary condition at a given edge side. |
| setExtrusionBoundaryConditionStepSuppression | This action sets the step suppression factor applied to the boundary condition at a given edge side. |
| Elliptic Solver Attributes | |
| ShapeConstraint | This attribute is the shape constraint of the structured domain. |
| ShapeProjection | This attribute is the shape projection method when constrained to database entities. |
| SolverEngine | This attribute is the elliptic solver engine employed when smoothing a structured domain. |
| MultiGridRelaxationFactor | This attribute is the relaxation factor of the multi-grid algorithm. |
| MultiGridProlongationFactor | This attribute is the Prolongation factor of the multi-grid algorithm. |
| RelaxationFactor | This attribute is the relaxation factor of the succesive over- relaxtion algorithm. |
| InteriorControl | This attribute is the interior control function of a structured domain. |
| EdgeControl | This attribute is the boundary control function of a structured domain Edge. |
| EdgeSpacingCalculation | This attribute is the boundary control function spacing calculation method. |
| EdgeSpacingBlend | This attribute is the boundary control function spacing blend method. |
| EdgeAngleCalculation | This attribute is the boundary control function angle calculation method. |
| EdgeAngleBlend | This attribute is the boundary control function angle blend method. |
| EdgeConstraint | This attribute is the boundary constraints of the structured domain. |
| Generic Extrusion Solver Attributes | |
| Mode | This attribute is the extrusion mode of this domain. |
| ShapeConstraint | This attribute is the shape constraint of the extrusion. |
| StopAtHeight | This attribute specifies a height stop condition or disables the stop condition with Off. |
| StopAtAspectRatio | This attribute specifies a max aspect ratio stop condition or disables the stop condition with Off. |
| StopAtSkewAngle | This attribute specifies a min skew angle stop condition or disables the stop condition with Off. |
| StopAtPositiveSkewJacobian | This attribute enables / disables the positive skew Jacobian stop condition. |
| StopAtZeroJacobian | This attribute enables / disables the zero Jacobian stop condition. |
| StopAtNegativeSkewJacobian | This attribute enables / disables the negative skew Jacobian stop condition. |
| StopAtNegativeJacobian | This attribute enables / disables the negative Jacobian stop condition. |
| Translational Extrusion Solver Attributes | |
| TranslateDirection | This attribute is the direction vector for translate extrusion. |
| TranslateDistance | This attribute is the distance for translate extrusion. |
| Path Extrusion Solver Attributes | |
| PathConnectors | This attribute is a list of connectors for the path. |
| PathMaximumSteps | This attribute is the maximum number of steps available as the path extrusion is configured. |
| PathUseTangent | This attribute is the flag indicating if the path extrusion should be rotated tangentially to the path connector. |
| Rotational Extrusion Solver Attributes | |
| RotateAxisStart | This attribute is the start position of the axis for rotate extrusion. |
| RotateAxisEnd | This attribute is the end position of the axis for rotate extrusion. |
| RotateAngle | This attribute is the angle (degrees) for rotational extrusion. |
| Normal Extrusion Solver Attributes | |
| NormalAspectRatio | This attribute is a factor that is applied to the step size in high aspect regions. |
| NormalExplicitSmoothing | This attribute sepcifies the explicit smoothing coefficient for the transverse direction. |
| NormalImplicitSmoothing | This attribute sepcifies the implicit smoothing coefficient for the transverse direction. |
| NormalKinseyBarthSmoothing | This attribute is the Kinsey-Barth coefficient to control smoothing in the marching direction. |
| NormalVolumeSmoothing | This attribute determines how rapidly grid point clustering along the initial grid will be relaxed as the grid is extruded. |
| NormalMarchingMode | This attribute gets/sets the marching mode for the extrusion. |
| NormalMarchingVector | This attribute gets/sets the marching vector direction for extrusion. |
| NormalInitialStepSize | This attribute gets/sets the value of the first marching step size. |
| NormalMaximumStepSize | This attribute gets/sets an upper limit for the marching step size. |
| NormalMinimumStepSize | This attribute gets/sets the upper limit for the marching step size. |
| NormalCornerFactor | This attribute gets/sets the scale factor for reducing/increasing the local marching step size in convex/concave regions. |
| NormalGridAngle | This attribute gets/sets the angle limit the normal marching vector can deviate. |
| NormalGridAngleIterations | This attribute gets/sets the number of smoothing iterations performed on the normal direction vector. |
| NormalDirectionRelaxation | This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the normal marching direction vector. |
| NormalDirectionRelaxationIterations | This attribute gets/sets the number of smoothing iterations performed on the normal marching direction vector. |
| NormalStepSizeRelaxation | This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the marching step size. |
| NormalStepSizeRelaxationIterations | This attribute gets/sets the number of smoothing iterations performed on the marching step size. |
| Spacing Extrusion Solver Attributes | |
| SpacingMode | This gets/sets the spacing configuration for the extrusion. |
| SpacingGrowthFactor | This gets/sets how the marching step size will grow from its initial value. |
| SpacingConnectors | This gets/sets the collection of connector-object and subconnector-index pairs that specify how the marching step size will grow from its initial value. |
pw::DomainStructured create
This action creates a new structured domain object.
This action has no parameters.
This action returns a new pw::DomainStructured object, with no edges or interior points.
createOnDatabase, createFromConnectors, createFromPoints, pw::Domain.addEdge
pw::DomainStructured createOnDatabase ?-merge tolerance? ?-splitConnectors split_angle? ?-joinConnectors join_angle? ?-parametricConnectors mode? ?-reject rejectVar? entities
This action creates new structured domain objects on the given database entities.
| -merge tolerance | This optional parameter is the tolerance for automatic connector merging. This is a float with the range [0, infinity) and the default is 0 which means that no merging will be done. |
| -splitConnectors split_angle | This optional parameter is the turning angle to split connectors. This is a float with the range [0, 180) and the default is 0 which means that no splitting will be done. |
| -joinConnectors join_angle | This optional parameter is the turning angle to join connectors. This is a float with the range [0, 180) and the default is 0 which means that no joining will be done. |
| -parametricConnectors mode | This optional parameter is the string mode for how connectors are created on parametric surfaces with options EndToEnd and Aligned. The default is EndToEnd. |
| -reject rejectVar | This optional parameter is a variable name to receive a list of pw::DatabaseEntity objects that were rejected for placing connectors on; if this is not given, no rejections will be reported. |
| entities | This required parameter is a list of pw::DatabaseEntity objects. |
This action returns a list of new pw::DomainStructured objects.
This command supports progress updates.
pw::DomainStructured createFromConnectors ?-manifold? ?-solid? ?-reject rejectVar? connectors
This action creates new structured domain objects from the given connectors.
| -manifold | This optional flag is the notification to limit domain creation to maintain a manifold topology. |
| -solid | This optional flag is the notification to create domains to close groups of domains into solids. |
| -reject rejectVar | This optional parameter is a variable name to receive a list of pw::Connector objects that were not used in creating the domains. |
| connectors | This required parameter is a list of pw::Connector objects. |
This action returns a list of new pw::DomainStructured objects.
This command supports progress updates.
create, createFromPoints, createOnDatabase, pw::Edge.create, pw::Edge.addConnector, pw::Domain.addEdge, pw::Creator
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 connectors. The domains may be created in a different order or may be created with different orientations. Use the explicit domain building routines (pw::Edge.create, create, pw::Edge.addConnector, and pw::Domain.addEdge commands) to build the domain in a controlled manner.
If this command is run inside of a Create pw::Mode, it will only be able to assemble domains 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::Edge objects directly.
pw::DomainStructured createFromPoints points
This action, given a list of lists of xyz vector values or database-constrained points, creates a new domain.
| points | This required parameter is the list of lists of xyz vector values or database-constrained points. |
This action returns the domain. If the specifications match an existing domain, the existing domain will be returned. Otherwise, the newly created domain will be returned.
create, createFromConnectors, createOnDatabase
This example creates a structured domain from list of lists of XYZ vector values.
Code
package require PWI_Glyph 3.18.3
pw::Application reset
set idim 5
set jdim 7
set origin {10 10 10}
set ivec {4 0 0}
set jvec {0 6 0}
set p000 $origin
# Generate two-dimensional XYZ array
set pts [list]
for {set j 1} {$j <= $jdim} {incr j} {
set y [ expr { [lindex $p000 1] + $jdim - \
[ expr {[lindex $jvec 1] * $j / $jdim} ] } ]
set iList [list]
for {set i 1} {$i <= $idim} {incr i} {
set x [ expr { [lindex $p000 0] + $idim - \
[ expr {[lindex $ivec 0] * $i / $idim} ] } ]
set pt [pwu::Vector3 set $x $y 10]
lappend iList $pt
}
lappend pts $iList
}
# Create domain using two-dimensional XYZ array
set dom [pw::DomainStructured createFromPoints $pts]
puts "Dimension [$dom getPointCount]"Output
Dimension (5 7)
pw::DomainStructured join ?-reject rejectVar? domains
This action joins as many of the given structured domains together as possible.
| -reject rejectVar | This optional parameter is a variable name to receive a list of pw::DomainStructured objects that were not used in joining. |
| domains | This required parameter is a list of pw::DomainStructured objects to join. |
This action returns a list of the pw::DomainStructured objects that were joined. The domains will contain sub grids that match the sub grids that were in the original domains, as well as a sub grid for each of the original domains. These sub grids will be ordered by their minimum index in I, and then J order.
This command supports progress updates.
pw::DomainStructured qualifyEdges edges
This action checks if a list of edges would be valid for defining a structured domain. The edges will be reversed as needed to maintain continuity.
| edges | This required parameter is a list of pw::Edge objects. |
This action returns a boolean, true if a valid set of edges.
pw::DomainStructured getOverlappingDomains edges
This action will get the domains that share corners with the edges passed in.
| edges | This required parameter is a list of pw::Edge objects. |
This action returns a list of the pw::DomainStructured objects that overlap with the domain that would be created from the edges passed in.
pw::DomainStructured getAutoCompleteHint edges
This action is valid only when 2 or more edges have been defined, it returns a list of connectors that will complete the domain definition.
| edges | This required parameter is a list of pw::Edge objects defined so far. |
This action returns a list of pw::Connector objects to continue the domain edge definition (may be an empty list).
pw::DomainStructured getDomainsFromDatabase ?-exclusive? database
This action gets a list of domains that are constrained to the given databases.
| -exclusive | This optional flag only allows domains that are exclusively on the given database. |
| database | This required parameter is a list of pw::DatabaseEntity objects. |
This action returns a list of pw::Domain objects.
This example shows how to get a list of constrained domains from a given quilt and shell. $shell(1) and $quilt(1) are referencing an existing shell and quilt.
Code
set doms [pw::DomainStructured getDomainsFromDatabase \ [list $quilt(1) $shell(1)]]
pw::DomainStructured getDomainSubGridsFromDatabase ?-exclusive? database
This action gets a list of subgrids that are constrained to the given databases.
| -exclusive | This optional flag only allows subgrids that are exclusively on the given database. |
| database | This required parameter is a list of pw::DatabaseEntity objects. |
This action returns a list of pw::DomainSubGrid objects.
This example shows how to get a list of constrained subdomains from a given quilt and shell. $shell(1) and $qlt(1) are referencing an existing shell and quilt.
Code
set subdoms [pw::DomainStructured getDomainSubGridsFromDatabase \ [list $qlt(1) $shell(1)]]
pw::DomainStructured get/setDefault EdgeControl < HilgenstockWhite | StegerSorenson | None >
This default is the boundary control function of all edges of a structured domain when it is created.
A string with options < HilgenstockWhite | StegerSorenson | None >.
The default value is HilgenstockWhite.
pw::DomainStructured get/setDefault SolverEngine < MulitGrid | SuccessiveOverRelaxation >
This default is the elliptic solver engine employed when smoothing a structured domain.
A string with options < MultiGrid | SuccessiveOverRelaxation >.
The default value is MultiGrid.
$dom getPoint ?-constrained constrainedVar? < index | ij_index >
This action gets the position of a domain grid point.
| index | This optional parameter is the integer linear index of the grid point to get in the range [1, number of points]. |
| ij_index | This optional parameter is the ij index of the grid point to get. |
| -constrained constrainedVar | This optional parameter is the string name of a variable. If the grid point is database constrained, this variable is set to true. If not constrained, it is set to false. |
Either index or ij_index parameter must be specified.
This action returns a point giving the grid point position (may be in the form “u v dbentity”).
$dom setPoint < index | ij_index > point
This action sets the position of a domain interior grid point.
| index | This optional parameter is the integer linear index of the target grid point to set in the range [1, number of points]. The index must be for an interior grid point. |
| ij_index | This optional parameter is the ij index of the grid point to set. |
| point | This required parameter is the new point value of the grid point. |
Either index or ij_index parameter must be specified.
This action returns nothing.
$dom isInteriorIndex < index | ij_index >
This action checks to see if an index corresponds to a point in the interior of the domain.
| index | This optional parameter is the integer linear index of the point to check in the range [1, number of points] |
| ij_index | This optional parameter is the ij index of the point to check. |
Either index or ij_index parameter must be specified.
This action returns true if the index is an interior point.
$dom getPosition ?-grid? value
This action gets the position in the defining space of the domain at the given index.
| -grid | This optional flag is the notification to get the position at a grid point. The value is a linear integer index or an ij index. This is the default option. |
| value | This required parameter is the value to get the position at. |
This action returns a point giving the position on the domain (may be in the form “u v dbentity”).
$dom getXYZ ?-grid? value
This action gets the position of the domain in model space at the given index.
| -grid | This optional flag is the notification to get the position at a grid point. The value is a linear integer index or an ij index. This is the default option. |
| value | This required parameter is the value to get the position at. |
This action returns an XYZ vector.
$dom getCell ?-uncollapsed? < index | ij_index >
This action gets the indices of the given cell.
| -uncollapsed | If this optional flag is specified, degenerate quad cells are returned without coincident grid points collapsed. By default, degenerate quad cells are collapsed before they are returned (see Notes). If a quad cell does NOT contain any coincident grid points, this option is ignored and a normal quad cell is returned. |
| index | This optional parameter is the the linear integer index of the cell to get. |
| ij_index | This optional parameter is the ij index of the cell to get. |
Either index or ij_index must be specified.
This action returns a list of linear integer point indices if the index parameter is used, or a list of ij point indices if the ij_index parameter is used.
Collaped (degenerate) quad cells are possible if a domain contains one or more poles. A collapsed quad may be returned as a 3-point tri, a 2-point bar, or a single point.
$dom getCellsUsingIndex ?-linear? < index | ij_index >
Returns the indices of the cells whose connectivity includes the specified index.
| -linear | If this optional flag is specified, the results will be a list of integer linear indices regardless of the input index form. |
| index | This optional parameter is the integer linear index of the grid point in the range [1, number of points]. |
| ij_index | This optional parameter is the ij index of the point to get. |
Either index or ij_index parameter must be specified.
This action returns a list of cell entries using the specified point. Each cell entry is a list of domain point indices comprising the cell.
The form of each domain point index will be the same as the input form. If index is used or -linear is specified, each cell entry will be a list of integer linear indices. If ij_index is used and -linear is not specified, each cell entry will be a list of ij indices.
$dom getXYZsAtIndex ?< -I | -J >? index
This action gets a line of points in the given direction at the given index.
| -I | This optional flag is the notification to use a constant I index. This is the default. |
| -J | This optional flag is the notification to use a constant J index. |
| index | This required parameter is the integer index to get the line at in the range [1, dimension in I or J]. |
This action returns a list of XYZ vectors.
$dom createSubGrid min_ij max_ij
This action creates a subgrid on this domain.
| min_ij | This required parameter is the minimum ij index. |
| max_ij | This required parameter is the maximum ij index. |
This action returns a new pw::DomainSubGrid object.
$dom getSubGridCount
This action gets the number of subgrids in this domain.
This action has no parameters.
This action returns the integer number of subgrids.
$dom getSubGrid index
This action gets the subgrid at the given index.
| index | This required parameter is the integer index of the subgrid to get in the range [1, number of subgrids]. |
This action returns a pw::DomainSubGrid object.
$dom getSubGrids
This action gets the subgrid list.
This action has no parameters.
This action returns a pw::DomainSubGrid object list.
$dom removeSubGrid < index | subgrid >
This action removes the subgrid from the domain.
| index | This optional parameter is the integer index of the subgrid to remove in the range [1, number of subgrids]. |
| subgrid | This optional parameter is a pw::DomainSubGrid object to remove. |
Either index or subgrid must be specified.
This action returns nothing.
$domain getEllipticSolverResidual ?-subgrid index? dataVar
This action gets the last elliptic solver residual info for the domain/subgrid at the given index.
| -subgrid index | This optional parameter is the integer index of the subgrid in the range [1, number of subgrids]. |
| dataVar | This required parameters is the string name of an array variable to receive residual information. The array will be cleared prior to setting any new values. |
This action returns nothing.
The data array variable will contain the following elements:
| TotalResidual | The root mean square of the point residuals. |
| MaximumResidual | The maximum point residual. |
| MaximumIndex | The index of the maximum point residual. |
This example shows how to get the last elliptic solver residual info for a domain refenced by $domain.
Code
$domain getEllipticSolverResidual residInfo puts "Total residual: $residInfo(TotalResidual)" puts "Max. residual: $residInfo(MaximumResidual)" puts "Max. residual index: $residInfo(MaximumIndex)"
$domain getEdge < index | boundary >
This action gets the edge at the given index or computational boundary.
| index | This optional parameter is the index of the edge to get in the range [1, number of edges]. |
| boundary | This optional parameter is the string computational boundary with options < IMinimum | IMaximum | JMinimum | JMaximum >. |
This action returns a pw::Edge object.
Either the edge index or computational boundary must be specified.
$dom project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?<-interior | -shape>? ?dbentities?
This action projects this domain onto one or more database entities.
| -type proj_type | This optional parameter is the string projection type to perform with options < ClosestPoint | Linear | SphericalIn | SphericalOut | CylindricalIn | CylindricalOut >. |
| -direction direction | This optional parameter is the projection vector for linear projection. The default is determined by the entity and can be queried using pw::Domain.getDefaultProjectDirection. |
| -center center | This optional parameter is the center point vector for spherical projection. The default is (0, 0, 0). |
| -axis point normal | This optional parameter is the axis defined by a point vector and normal vector used by cylindrical projection; The default point is (0, 0, 0) and the default normal is (1, 0, 0). |
| -interior | If this optional flag is present, only the interior of the entities are projected. |
| -shape | If this optional flag is present, the shape of the domain’s connectors will be projected to the database and the original distributions will be reapplied after the projection. |
| dbentities | This optional parameter is a list of surface-like pw::DatabaseEntity objects to project onto. If none are given, project to any currently enabled, visible database surface-like entities. |
This action returns nothing.
pw::Domain.getDefaultProjectDirection
This example shows how to project a domain linearly along the Z axis onto the given quilt. $dom(1) and $quilt(1) are referencing an existing domain and quilt.
Code
$dom(1) project -type Linear -direction "0 0 1" $quilt(1)
$dom split ?< -I | -J >? indices
This action splits this domain in the given direction at the given indices.
| -I | This optional flag is the notification to split at a constant I index. This is the default. |
| -J | This optional flag is the notification to split at a constant J index. |
| indices | This required parameter is a list of integer indices to split at in the range (1, dimension in I or J). |
This action returns a list of pw::DomainStructured objects.
Any duplicate indices will be ignored, as well as indices at the limits of the domain.
$dom join domain ?side?
This action joins the given domain to this domain.
| domain | This required parameter is the pw::DomainStructured object to join. |
| side | This optional string parameter is the given domain’s side to join to this domain. Valid values are < Any | IMinimum | IMaximum | JMinimum | JMaximum >. |
This action returns nothing.
The joined domain will contain sub grids that match the sub grids that were in the original domains, as well as a sub grid for each of the original domains. These sub grids will be ordered by their minimum index in I, and then J order.
$dom setOrientation i_edge j_edge
This action sets the orientation of this domain, by specifying the imin and jmin edges of the domain. A domain used in a baffle face can not be flipped.
| i_edge | This required parameter is the integer index or string boundary to be used as the Imin Edge. |
| j_edge | This required parameter is the integer index or string boundary to be used as the Jmin Edge. |
This action returns nothing.
For both the i_egde and j_edge the following boundary keywords or the associated index may be used: JMinimum = 1, IMaximum = 2, JMaximum = 3, IMinimum = 4.
$dom alignOrientation domains
This action aligns the IJK orientation of the given domains with this domain. If any domains in the given list are not topologically connected to this domain, they will be ignored. An error is raised if a domain in a baffle face is specified in the list of domains.
| domains | This required parameter is a list of pw::DomainStructured objects to align. |
This action returns nothing.
$entity canReExtrude
This action returns true if the entity can be re-extruded.
none
This action returns a boolean value indicating if the entity can be re-extruded.
This example shows how to get a list of all entities that can be re-extruded.
Code
puts "Entities valid for re-extrusion:"
set reExtEnts [list]
foreach ent [pw::Grid getAll] {
if [$ent canReExtrude] {
lappend reExtEnts $ent
puts " [$ent getName]"
}
}
$dom triangulate ?-link? ?-unbalanced option? ?method?
This action creates an unstructured domain by triangulating this domain.
| -link | If provided, this optional flag maintains a permanent link between the structured domain and the resulting unstructured domain. Any future changes in the structured domain will automatically result in the unstructured domain being retriangulated from the updated structured domain. The link is broken if the structured domain is destroyed. This option is invalid if Initialized is specified as the method. |
| -unbalanced option | This optional parameter determines how the unstructured domain will be updated if the linked structured domain becomes unbalanced. This option is invalid if Initialized is specified as the method. The two options are < Initialize | Interpolate >. The Interpolate option sets the solver pw::DomainUnstructured.Algorithm to ThinSurfaceInterpolation. With Initialize, the domain will be initialized using the default or otherwise explicitly set algorithm. |
| method | This optional parameter is the string triangulation method with options < BestFit | Aligned | Initialized | KeepQuads >. BestFit is the default option. |
This action returns a pw::DomainUnstructured object.
The different methods have the following behavoir:
$dom getInitializeMethod ?-axis pointVar normalVar?
This action gets the initialization method for this domain.
| -axis pointVar normalVar | This optional parameter specifies a string variable name to receive the polar axis point vector and a string variable name to receive the polar axis normal vector. |
This action returns the string initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >.
$dom setInitializeMethod ?-axis point normal? method
This action sets the initialization method for this domain.
| -axis point normal | This optional parameter is the polar axis point vector and normal vector. |
| method | This required parameter is the initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >. |
This action returns nothing.
$dom getEllipticSolverAttribute ?-edge index? att_name ?value_type?
This action gets the named elliptic solver attribute.
| -edge index | This optional parameter is the integer index of the edge to get the attribute from. If not given and the attribute applies to edges, a list of attributes will be returned. |
| att_name | This required parameter is the string name of the attribute to get. |
| value_type | This optional parameter is the type of value to get with options < Actual | Default >. |
This action returns the actual or default value of the attribute.
$dom setEllipticSolverAttribute ?-edge index? att_name att_value
This action sets the named elliptic solver attribute.
| -edge index | This optional parameter is the integer index of the edge to set the attribute to. If not given the attribute is applied to all edges. |
| att_name | This required parameter is the string name of the attribute to set. |
| att_value | This required parameter is the new string, integer or float value of the attribute. |
This action returns nothing.
$dom setExtrusionSolverAttribute att_name att_value
This action sets the named extrusion solver attribute.
| att_name | This required parameter is the string name of the attribute to set. |
| att_value | This required parameter is the new string, integer or float value of the attribute. |
<getExtrusionSolverAttribute>
This action returns nothing.
$domain getExtrusionBoundaryCondition edge_side
This action gets the boundary condition at a given edge side.
| edge_side | This required parameter is the string side of the edge with options < Begin | End >. |
This action returns the name of the boundary condition and any additional arguments (for example, the Splay condition also returns the splay factor). The additional arguments are in the same format and order as needed for the setExtrusionBoundaryCondition command.
| Splay | Grid boundaries move outward according to the splay factor. |
| ConstantX | Grid points on the front maintain a constant X coordinate value. |
| ConstantY | Grid points on the front maintain a constant Y coordinate value. |
| ConstantZ | Grid points on the front maintain a constant Z coordinate value. |
| SymmetryX | Grid symmetry is maintained in the X direction. |
| SymmetryY | Grid symmetry is maintained in the Y direction. |
| SymmetryZ | Grid symmetry is maintained in the Z direction. |
$domain setExtrusionBoundaryCondition edge_side boundary_condition ?splay_factor?
This action sets the boundary condition at a given connector region.
| edge_side | This required parameter is the string side of the edge with options < Begin | End >. |
| boundary_condition | This required parameter is the string type of boundary condition with options < Splay | ConstantX | ConstantY | ConstantZ | SymmetryX | SymmetryY | SymmetryZ >. |
| splay_factor | This optional parameter must be given if the boundary_condition given is Splay. The parameter is either the literal string Default or a float in the range [0.0, 1.0]. 0.0 indicates no splay while 1.0 is full splay. If Default is specified, a splay of 0.1 is used. |
This action returns nothing.
$domain getExtrusionBoundaryConditionStepSuppression edge_side
This action gets the step suppression factor applied to the boundary condition at a given edge side.
| edge_side | This required parameter is the string side of the edge with options < Begin | End >. |
This action returns the value of the edge suppression applied upon the requested side.
$domain setExtrusionBoundaryConditionStepSuppression edge_side factor
This action sets the step suppression factor applied to the boundary condition at a given edge side.
| edge_side | This required parameter is the string side of the edge with options < Begin | End >. |
| factor | This required parameter is a float value with the range [-1.0, 1.0]. |
This action returns nothing.
$dom get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >
This attribute is the shape constraint of the structured domain.
A string with options < Free | Fixed | Database > or an explicit list of pw::DatabaseEntity objects.
The default for this attribute is Free.
$dom get/setEllipticSolverAttribute ShapeProjection < method | normal >
This attribute is the shape projection method when constrained to database entities.
A string with options < Closest | Linear > or an explicit normal vector for linear projection. When Linear is specified the projection uses the domain’s default projection direction which can be queried with pw::Domain.getDefaultProjectDirection.
The default for this attribute is Closest.
$domain get/setEllipticSolverAttribute SolverEngine function
This attribute is the elliptic solver engine employed when smoothing a structured domain.
A string with options < MultiGrid | SuccessiveOverRelaxation >.
The defult for this attribute is the value in the SolverEngine (Default) when the domain was created.
setEllipticSolverAttribute, getEllipticSolverAttribute, SolverEngine
$dom get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
A string with options < Optimal | Nominal > or a float in the range (0.0, 2.0].
The default for this attribute is Optimal.
$dom get/setEllipticSolverAttribute InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This attribute is the interior control function of a structured domain.
This attribute is a string with options < ThomasMiddlecoff | Laplace | Fixed >.
The default for this attribute is the value in the <InteriorControl (Default)> default when the domain was created.
setEllipticSolverAttribute, getEllipticSolverAttribute, <InteriorControl (Default)>
$dom get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function of a structured domain Edge.
A string with options < HilgenstockWhite | StegerSorenson | None >.
The default for this attribute is the value in the EdgeControl (Default) default when the domain was created.
setEllipticSolverAttribute, getEllipticSolverAttribute, EdgeControl (Default)
$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing calculation method.
A string with options < Interpolate | Current | Adjacent > or an explicit spacing value in the range (0.0, infinity).
The default for this attribute is Interpolate.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < Exponential | Linear | value >
This attribute is the boundary control function spacing blend method.
A string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity).
The default for this attribute is Exponential.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle calculation method.
A string with options < Orthogonal | Interpolate | Current | Adjacent >.
The default for this attribute is Orthogonal.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < Exponential | Linear | value >
This attribute is the boundary control function angle blend method.
A string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity).
The default for this attribute is Exponential.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeConstraint < Fixed | Floating | Orthogonal >
This attribute is the boundary constraints of the structured domain.
A string wth options < Fixed | Floating | Orthogonal >.
The default for this attribute is Fixed.
$dom get/setExtrusionSolverAttribute Mode mode
This attribute is the extrusion mode of this domain.
A string with options < NormalHyperbolic | NormalAlgebraic | Path | Rotate | Translate >.
The default for this attribute is NormalHyperbolic.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute ShapeConstraint < Free | Database > ?db_list?
This attribute is the shape constraint of the extrusion.
A string with options < Free | Database >. If Database is specified, a list of surface-like pw::DatabaseEntity objects must follow.
The default for this attribute is Free.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute StopAtHeight < Default | Off | Value >
This attribute specifies a height stop condition or disables the stop condition with Off.
A float in the range (0, infinity] or a string with options < Off | Default > where Off disables the total height stop condition.
The default for this attribute is Off.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
This attribute specifies a max aspect ratio stop condition or disables the stop condition with Off.
A float in the range (0, infinity] or a string with options < Off | Default > where Off disables the aspect ratio stop condition.
The default for this attribute is Off.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
This attribute specifies a min skew angle stop condition or disables the stop condition with Off.
A float in the range (0, infinity] or a string with options < Off | Default > where Off disables the skew angle stop condition.
The default for this attribute is Off.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute StopAtPositiveSkewJacobian < Default | Off | bool >
This attribute enables / disables the positive skew Jacobian stop condition.
A boolean where true indicates the positive skew Jacobian stop condition is applied, or a string with options < Default | Off > where Off disables the positive skew Jacobian stop condition.
The default for this attribute is true.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute StopAtZeroJacobian < Default | Off | bool >
This attribute enables / disables the zero Jacobian stop condition.
A boolean where true indicates that the zero Jacobian stop condition is applied, or a string with options < Default | Off > where Off disables the zero Jacobian stop condition.
The default for this attribute is true.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute StopAtNegativeSkewJacobian < Default | Off | bool >
This attribute enables / disables the negative skew Jacobian stop condition.
A boolean where true indicates that the negative Jacobian stop condition is applied, or a string with options < Default | Off > where Off disables the negative skew Jacobian stop condition.
The default for this attribute is true.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute StopAtNegativeJacobian < Default | Off | bool >
This attribute enables / disables the negative Jacobian stop condition.
A boolean where true indicates that the negative Jacobian stop condition is applied.
The default for this attribute is true.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute TranslateDirection < Default | value_XYZ >
This attribute is the direction vector for translate extrusion.
A normalized direction vector.
This default for this attribute is (1, 0, 0).
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute TranslateDistance < Default | value >
This attribute is the distance for translate extrusion.
A float in the range [0, infinity).
The default for this attribute is 1.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute PathConnectors con_list
This attribute is a list of connectors for the path.
A list of pw::Connector optionally preceded with a string with value < Forward | Reverse > indicating the direction of the chain of connectors. When querying, the direction is always the first entry in the list. The remaining list members are the connectors comprising the path.
The default for this attribute is an empty list.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom getExtrusionSolverAttribute PathMaximumSteps
This attribute is the maximum number of steps available as the path extrusion is configured.
An integer indicating the maximum number of path steps to extrude.
The default for this attribute is 0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute PathUseTangent < Default | bool >
This attribute is the flag indicating if the path extrusion should be rotated tangentially to the path connector.
A boolean where true indicates that the path extrusion should be rotated tangentially to the path connector.
The default for this attribute is true.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute RotateAxisStart < Default | value_XYZ >
This attribute is the start position of the axis for rotate extrusion.
An xyz vector or the literal string Default.
The default for this attribute is (0, 0, 0).
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute RotateAxisEnd < Default | value_XYZ >
This attribute is the end position of the axis for rotate extrusion.
An xyz vector or the literal string Default.
The default for this attribute is (0, 0, 0).
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute RotateAngle < Default | value_XYZ >
This attribute is the angle (degrees) for rotational extrusion.
A float in the range [0.0, 360].
The default for this attribute is 0.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalAspectRatio < Default | value >
This attribute is a factor that is applied to the step size in high aspect regions. A value of 0.0 results in no change to the step size.
A float in the range [0.0, 1.0].
The default for this attribute is 0.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalExplicitSmoothing < Default | value >
This attribute sepcifies the explicit smoothing coefficient for the transverse direction.
A string with the value < Default > or a float in the range [0.0, 10.0].
The default for this attribute is 0.5.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
This attribute sepcifies the implicit smoothing coefficient for the transverse direction. The value should be greater than twice the NormalExplicitSmoothing value.
A string with the value < Default > or a float in the range (0.0, infinity).
The default for this attribute is 1.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalKinseyBarthSmoothing < Default | value >
This attribute is the Kinsey-Barth coefficient to control smoothing in the marching direction. Values greater than 1 help to prevent crossing of grid lines in the marching direction. A value of 3 or better is recommended if the initial grid contains severe concavities.
A string with the value < Default > or a float in the range (0.0, infinity).
The default for this attribute is 0.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalVolumeSmoothing < Default | value >
This attribute determines how rapidly grid point clustering along the initial grid will be relaxed as the grid is extruded. A value of 0.0 retains the clustering out to the outer boundary. The Default value of 0.5 rapidly relaxes the clustering.
A string with the value < Default > or a float in the range [0.0, 1.0].
The default for this attribute is 0.5.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalMarchingMode mode
This attribute gets/sets the marching mode for the extrusion. “Plane” specifies marching each point from a plane with a normal of the NormalMarchingVector. “Direction” specifies marching in the direction of the NormalMarchingVector.
A string with options < Plane | Direction >.
The default for this attribute is Plane.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalMarchingVector value_xyz
This attribute gets/sets the marching vector direction for extrusion. When NormalMarchingMode is set to “Plane”, this specifies the normal of the plane. When NormalMarchingMode is set to “Direction”, this specifies the marching direction.
A direction vector.
The default for this attribute is (0, 0, 0).
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalInitialStepSize value
This attribute gets/sets the value of the first marching step size.
A float in the range (0.0, infinity).
The default for this attribute is the default connector distribution begin spacing, if non-zero or 0.01.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalMaximumStepSize value
This attribute gets/sets an upper limit for the marching step size.
A float in the range [0, infinity). 0.0 means disable this limit.
The default for this attribute is 0.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalMinimumStepSize value
This attribute gets/sets the upper limit for the marching step size.
A float in the range [0, infinity). 0.0 means disable this limit.
The default for this attribute is 0.0.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalCornerFactor value
This attribute gets/sets the scale factor for reducing/increasing the local marching step size in convex/concave regions.
A float in the range [1, infinity). The value 1.0 will disable the feature.
The default for this attribute is 5.0.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalGridAngle < Default | angle >
This attribute gets/sets the angle limit the normal marching vector can deviate. This attribute is the marching direction is smoothed by adding a component to the local trajectory of each grid line. This component is obtained by smoothing the grid at the current step, computing the relative movement of each grid point, and adding that movement to the normal vector in the marching direction. This option limits the component to the given angle (degrees).
A string with the value < Default > or A float in the range [0.0, 90.0].
The default for this attribute is 20.0.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalGridAngleIterations < Default | iterations >
This attribute gets/sets the number of smoothing iterations performed on the normal direction vector.
A string with the value < Default > or an integer in the range [0, infinity).
The default for this attribute is 0.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalDirectionRelaxation < Default | factor >
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the normal marching direction vector.
A string with the value < Default > or float in the range [0.0, 1.0].
The default for this attribute is 0.5.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute> This attribute only affects algebraic normal extrusion.
$dom get/setExtrusionSolverAttribute NormalDirectionRelaxationIterations < Default | iterations >
This attribute gets/sets the number of smoothing iterations performed on the normal marching direction vector.
A string with the value < Default > or an integer in the range [0, infinity).
The default for this attribute is 5.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxation < Default | factor >
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the marching step size.
A string with the value < Default > or a float in the range [0.0, 1.0].
The default for this attribute is 0.7.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxationIterations < Default | iterations >
This attribute gets/sets the number of smoothing iterations performed on the marching step size.
A string with the value < Default > or an integer in the range [0, infinity).
Default: The default for this attribute is 3.
This attribute only affects algebraic normal extrusion.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute SpacingMode < Default | Algebraic | Connector >
This gets/sets the spacing configuration for the extrusion.
A string with options < Algebraic | Connector | Default >.
The default for this attribute is Algebraic.
The Algebraic mode uses a linear spacing for translational, rotational and path extrusions. For normal extrusions, Algebraic mode spaces the grid by applying a geometric growth controlled by SpacingGrowthFactor.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute SpacingGrowthFactor value
This gets/sets how the marching step size will grow from its initial value.
A float in the range (0.0, infinity).
The default is 1.10.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
$dom get/setExtrusionSolverAttribute SpacingConnectors subcon_list
This gets/sets the collection of connector-object and subconnector-index pairs that specify how the marching step size will grow from its initial value.
A list of subconnectors where each entry is a list containing a pw::Connector object and subconnector index. If the pw::Connector only has one subconnector, the index can be omitted. The direction of the chain of subconnectors can be specified by using either the literal string Forward or Reverse as the very first entry. This is only necessary when the list of subconnectors is comprised of a single subconnector. Otherwise, the direction can be determined from the order of the subconnectors.
The default for this attribute is an empty list.
setExtrusionSolverAttribute, <getExtrusionSolverAttribute>
This example sets the SpacingConnectors extrusion solver attribute. $con(1), $con(2), $con(3), $dom(1) and $dom(2) refer to existing connectors and structured domains. $con(1) and $con(2) have only one subconnector, while $con(3) has at least two subconnectors.
Code
set spacers [list $con(1) $con(2) [list $con(3) 1] [list $con(3) 2]] set extruder [pw::Application begin ExtrusionSolver [list $dom(1)]] $extruder setExtrusionSolverAttribute Mode Translate $extruder setExtrusionSolverAttribute SpacingConnectors $spacers $extruder run 10 $extruder end set spacers [list Reverse $con(2)] set extruder [pw::Application begin ExtrusionSolver [list $dom(2)]] $extruder setExtrusionSolverAttribute Mode Translate $extruder setExtrusionSolverAttribute SpacingConnectors $spacers $extruder run 10 $extruder end
This action creates a new structured domain object.
pw::DomainStructured create
This action creates new structured domain objects on the given database entities.
pw::DomainStructured createOnDatabase ?-merge tolerance? ?-splitConnectors split_angle? ?-joinConnectors join_angle? ?-parametricConnectors mode? ?-reject rejectVar? entities
This action creates new structured domain objects from the given connectors.
pw::DomainStructured createFromConnectors ?-manifold? ?-solid? ?-reject rejectVar? connectors
This action, given a list of lists of xyz vector values or database-constrained points, creates a new domain.
pw::DomainStructured createFromPoints points
This action joins as many of the given structured domains together as possible.
pw::DomainStructured join ?-reject rejectVar? domains
This action checks if a list of edges would be valid for defining a structured domain.
pw::DomainStructured qualifyEdges edges
This action will get the domains that share corners with the edges passed in.
pw::DomainStructured getOverlappingDomains edges
This action is valid only when 2 or more edges have been defined, it returns a list of connectors that will complete the domain definition.
pw::DomainStructured getAutoCompleteHint edges
This action gets a list of domains that are constrained to the given databases.
pw::DomainStructured getDomainsFromDatabase ?-exclusive? database
This action gets a list of subgrids that are constrained to the given databases.
pw::DomainStructured getDomainSubGridsFromDatabase ?-exclusive? database
This default is the boundary control function of all edges of a structured domain when it is created.
pw::DomainStructured get/setDefault EdgeControl < HilgenstockWhite | StegerSorenson | None >
This default is the elliptic solver engine employed when smoothing a structured domain.
pw::DomainStructured get/setDefault SolverEngine < MulitGrid | SuccessiveOverRelaxation >
This action gets the position of a domain grid point.
$dom getPoint ?-constrained constrainedVar? < index | ij_index >
This action sets the position of a domain interior grid point.
$dom setPoint < index | ij_index > point
This action checks to see if an index corresponds to a point in the interior of the domain.
$dom isInteriorIndex < index | ij_index >
This converts a domain’s ij index to a integer linear index.
$dom getLinearIndex ij_index
This action gets the position in the defining space of the domain at the given index.
$dom getPosition ?-grid? value
This action gets the position of the domain in model space at the given index.
$dom getXYZ ?-grid? value
This action gets the indices of the given cell.
$dom getCell ?-uncollapsed? < index | ij_index >
Returns the indices of the cells whose connectivity includes the specified index.
$dom getCellsUsingIndex ?-linear? < index | ij_index >
This action gets a line of points in the given direction at the given index.
$dom getXYZsAtIndex ?< -I | -J >? index
This action creates a subgrid on this domain.
$dom createSubGrid min_ij max_ij
This action gets the number of subgrids in this domain.
$dom getSubGridCount
This action gets the subgrid at the given index.
$dom getSubGrid index
This action gets the subgrid list.
$dom getSubGrids
This action removes the subgrid from the domain.
$dom removeSubGrid < index | subgrid >
This action gets the last elliptic solver residual info for the domain/subgrid at the given index.
$domain getEllipticSolverResidual ?-subgrid index? dataVar
This action gets the edge at the given index or computational boundary.
$domain getEdge < index | boundary >
This action projects this domain onto one or more database entities.
$dom project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?<-interior | -shape>? ?dbentities?
This action splits this domain in the given direction at the given indices.
$dom split ?< -I | -J >? indices
This action sets the orientation of this domain, by specifying the imin and jmin edges of the domain.
$dom setOrientation i_edge j_edge
This action aligns the IJK orientation of the given domains with this domain.
$dom alignOrientation domains
This action returns true if the entity can be re-extruded.
$entity canReExtrude
This action creates an unstructured domain by triangulating this domain.
$dom triangulate ?-link? ?-unbalanced option? ?method?
This action gets the initialization method for this domain.
$dom getInitializeMethod ?-axis pointVar normalVar?
This action sets the initialization method for this domain.
$dom setInitializeMethod ?-axis point normal? method
This action gets the named elliptic solver attribute.
$dom getEllipticSolverAttribute ?-edge index? att_name ?value_type?
This action sets the named elliptic solver attribute.
$dom setEllipticSolverAttribute ?-edge index? att_name att_value
This action sets the named extrusion solver attribute.
$dom setExtrusionSolverAttribute att_name att_value
This action gets the boundary condition at a given edge side.
$domain getExtrusionBoundaryCondition edge_side
This action sets the boundary condition at a given connector region.
$domain setExtrusionBoundaryCondition edge_side boundary_condition ?splay_factor?
This action gets the step suppression factor applied to the boundary condition at a given edge side.
$domain getExtrusionBoundaryConditionStepSuppression edge_side
This action sets the step suppression factor applied to the boundary condition at a given edge side.
$domain setExtrusionBoundaryConditionStepSuppression edge_side factor
This attribute is the shape constraint of the structured domain.
$dom get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >
This attribute is the shape projection method when constrained to database entities.
$dom get/setEllipticSolverAttribute ShapeProjection < method | normal >
This attribute is the elliptic solver engine employed when smoothing a structured domain.
$domain get/setEllipticSolverAttribute SolverEngine function
This attribute is the relaxation factor of the multi-grid algorithm.
$domain get/setEllipticSolverAttribute MultiGridRelaxationFactor < Default | value >
This attribute is the Prolongation factor of the multi-grid algorithm.
$domain get/setEllipticSolverAttribute MultiGridProlongationFactor < Default | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
$dom get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | value >
This attribute is the interior control function of a structured domain.
$dom get/setEllipticSolverAttribute InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This attribute is the boundary control function of a structured domain Edge.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function spacing calculation method.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing blend method.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < Exponential | Linear | value >
This attribute is the boundary control function angle calculation method.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle blend method.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < Exponential | Linear | value >
This attribute is the boundary constraints of the structured domain.
$dom get/setEllipticSolverAttribute ?-edge index? EdgeConstraint < Fixed | Floating | Orthogonal >
This attribute is the extrusion mode of this domain.
$dom get/setExtrusionSolverAttribute Mode mode
This attribute specifies a height stop condition or disables the stop condition with Off.
$dom get/setExtrusionSolverAttribute StopAtHeight < Default | Off | Value >
This attribute enables / disables the positive skew Jacobian stop condition.
$dom get/setExtrusionSolverAttribute StopAtPositiveSkewJacobian < Default | Off | bool >
This attribute enables / disables the zero Jacobian stop condition.
$dom get/setExtrusionSolverAttribute StopAtZeroJacobian < Default | Off | bool >
This attribute enables / disables the negative skew Jacobian stop condition.
$dom get/setExtrusionSolverAttribute StopAtNegativeSkewJacobian < Default | Off | bool >
This attribute enables / disables the negative Jacobian stop condition.
$dom get/setExtrusionSolverAttribute StopAtNegativeJacobian < Default | Off | bool >
This attribute is the direction vector for translate extrusion.
$dom get/setExtrusionSolverAttribute TranslateDirection < Default | value_XYZ >
This attribute is the distance for translate extrusion.
$dom get/setExtrusionSolverAttribute TranslateDistance < Default | value >
This attribute is a list of connectors for the path.
$dom get/setExtrusionSolverAttribute PathConnectors con_list
This attribute is the maximum number of steps available as the path extrusion is configured.
$dom getExtrusionSolverAttribute PathMaximumSteps
This attribute is the flag indicating if the path extrusion should be rotated tangentially to the path connector.
$dom get/setExtrusionSolverAttribute PathUseTangent < Default | bool >
This attribute is the start position of the axis for rotate extrusion.
$dom get/setExtrusionSolverAttribute RotateAxisStart < Default | value_XYZ >
This attribute is the end position of the axis for rotate extrusion.
$dom get/setExtrusionSolverAttribute RotateAxisEnd < Default | value_XYZ >
This attribute is the angle (degrees) for rotational extrusion.
$dom get/setExtrusionSolverAttribute RotateAngle < Default | value_XYZ >
This attribute is a factor that is applied to the step size in high aspect regions.
$dom get/setExtrusionSolverAttribute NormalAspectRatio < Default | value >
This attribute sepcifies the explicit smoothing coefficient for the transverse direction.
$dom get/setExtrusionSolverAttribute NormalExplicitSmoothing < Default | value >
This attribute is the Kinsey-Barth coefficient to control smoothing in the marching direction.
$dom get/setExtrusionSolverAttribute NormalKinseyBarthSmoothing < Default | value >
This attribute determines how rapidly grid point clustering along the initial grid will be relaxed as the grid is extruded.
$dom get/setExtrusionSolverAttribute NormalVolumeSmoothing < Default | value >
This attribute gets/sets the marching mode for the extrusion.
$dom get/setExtrusionSolverAttribute NormalMarchingMode mode
This attribute gets/sets the marching vector direction for extrusion.
$dom get/setExtrusionSolverAttribute NormalMarchingVector value_xyz
This attribute gets/sets the value of the first marching step size.
$dom get/setExtrusionSolverAttribute NormalInitialStepSize value
This attribute gets/sets an upper limit for the marching step size.
$dom get/setExtrusionSolverAttribute NormalMaximumStepSize value
This attribute gets/sets the upper limit for the marching step size.
$dom get/setExtrusionSolverAttribute NormalMinimumStepSize value
This attribute gets/sets the scale factor for reducing/increasing the local marching step size in convex/concave regions.
$dom get/setExtrusionSolverAttribute NormalCornerFactor value
This attribute gets/sets the angle limit the normal marching vector can deviate.
$dom get/setExtrusionSolverAttribute NormalGridAngle < Default | angle >
This attribute gets/sets the number of smoothing iterations performed on the normal direction vector.
$dom get/setExtrusionSolverAttribute NormalGridAngleIterations < Default | iterations >
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the normal marching direction vector.
$dom get/setExtrusionSolverAttribute NormalDirectionRelaxation < Default | factor >
This attribute gets/sets the number of smoothing iterations performed on the normal marching direction vector.
$dom get/setExtrusionSolverAttribute NormalDirectionRelaxationIterations < Default | iterations >
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the marching step size.
$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxation < Default | factor >
This attribute gets/sets the number of smoothing iterations performed on the marching step size.
$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxationIterations < Default | iterations >
This gets/sets the spacing configuration for the extrusion.
$dom get/setExtrusionSolverAttribute SpacingMode < Default | Algebraic | Connector >
This gets/sets how the marching step size will grow from its initial value.
$dom get/setExtrusionSolverAttribute SpacingGrowthFactor value
This gets/sets the collection of connector-object and subconnector-index pairs that specify how the marching step size will grow from its initial value.
$dom get/setExtrusionSolverAttribute SpacingConnectors subcon_list
This action adds an edge to the domain.
$dom addEdge edge
This action creates a new edge object.
pw::Edge create
This action adds a connector to the end of this edge.
$edge addConnector connector
This action gets the default projection direction for this domain.
$dom getDefaultProjectDirection
This attribute is the algorithm to use when initializing the interior of the domain.
$dom get/setUnstructuredSolverAttribute Algorithm < Delaunay | AdvancingFront | AdvancingFrontOrtho | ThinSurfaceInterpolation >.