pw:: DomainStructured

pw::DomainStructured create

This action creates a new structured domain object.

Parameters

This action has no parameters.

Returns

This action returns a new pw::DomainStructured object.

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.

Parameters

Returns

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

Information

This command supports progress updates.

pw::DomainStructured createFromConnectors ?-manifold? ?-solid? ?-reject rejectVar? connectors

This action creates new structured domain objects from the given connectors.

Parameters

Returns

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

Information

This command supports progress updates.

Notes

While this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input 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, pw::DomainStructured.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 join ?-reject rejectVar? domains

This action joins as many of the given structured domains together as possible.

Parameters

Returns

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.

Information

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.

Parameters

Returns

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.

Parameters

Returns

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.

Parameters

Returns

This action returns a list of pw::Connector objects to continue the domain edge definition (may be an empty list).

pw::DomainStructured get/setDefault InteriorControl func

This default is the interior control function of a structured domain when it is created.

Type

This default is a string with options < ThomasMiddlecoff | Laplace | Fixed >.

Default

The default value is ThomasMiddlecoff.

pw::DomainStructured get/setDefault EdgeControl func

This default is the boundary control function of all edges of a structured domain when it is created.

Type

This default is a string with options < HilgenstockWhite | StegerSorenson | None >.

Default

The default value is HilgenstockWhite.

pw::DomainStructured get/setDefault SolverEngine function

This default is the elliptic solver engine employed when smoothing a structured domain.

Type

This default is a string with options < MultiGrid | SuccessiveOverRelaxation >.

Default

The default value is MultiGrid.

$dom getPoint ?-constrained constrainedVar? < index | ij_index >

This action gets the position of a domain grid point.

Parameters

Returns

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.

Parameters

Returns

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.

Parameters

Returns

This action returns true if the index is an interior point.

$dom getLinearIndex ij_index

This converts a domain’s ij index to a integer linear index.

Parameters

Returns

This action returns the integer linear index value of the point.

$dom getPosition ?-grid? value

This action gets the position in the defining space of the domain at the given index.

Parameters

Returns

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.

Parameters

Returns

This action returns an XYZ vector.

$dom getCell ?-uncollapsed? < index | ij_index >

This action gets the indices of the given cell.

Parameters

Returns

This action returns a list of linear point indicies if the index parameter is used, or a list of ij point indicies if the ij_index parameter is used.

Notes

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 getXYZsAtIndex ?< -I | -J >? index

This action gets a line of points in the given direction at the given index.

Parameters

Returns

This action returns a list of XYZ vectors.

$dom createSubGrid min_ij max_ij

This action creates a subgrid on this domain.

Parameters

Returns

This action returns a new pw::DomainSubGrid object.

$dom getSubGridCount

This action gets the number of subgrids in this domain.

Parameters

This action has no parameters.

Returns

This action returns the number of subgrids.

$dom getSubGrid index

This action gets the subgrid at the given index.

Parameters

Returns

This action returns a pw::DomainSubGrid object.

$dom removeSubGrid < index | subgrid >

This action removes the subgrid from the domain.

Parameters

Returns

This action returns nothing.

$domain getEdge < index | boundary >

This action gets the edge at the given index or computational boundary.

Parameters

Returns

This action returns a pw::Edge object.

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

Parameters

Returns

This action returns nothing.

Example

This example shows how to project a domain linearly along the Z axis onto the given quilt.  $dom(1) and $qlt(1) are referencing an existing domain and quilt.

Code

$dom(1) project -type Linear -direction "0 0 1" $qlt(1)

$dom split ?< -I | -J >? indices

This action splits this domain in the given direction at the given indices.

Parameters

Returns

This action returns a list of pw::DomainStructured objects.

Information

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.

Parameters

Returns

This action returns nothing.

Information

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.

Parameters

Returns

This action returns nothing.

Information

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.

Parameters

Returns

This action returns nothing.

$entity canReExtrude

This action returns true if the entity can be re-extruded.

Parameters

none

Returns

This action returns a boolean value indicating if the entity can be re-extruded.

Example

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 ?method?

This action creates an unstructured domain by triangulating this domain.

Parameters

Returns

This action returns a pw::DomainUnstructured object.

Information

The different methods have the following behavoir:

• BestFit splits quads individually to minimize the triangle included angles.
• Aligned will split all structured quads in the same direction.
• Initialize will empty all interior points and retriangulate.
• KeepQuads will convert a structured grid into an unstructured grid by keeping all of the quad elements except for those adjacent to poles, which will be converted to triangles.

$dom getInitializeMethod ?-axis pointVar normalVar?

This action gets the initialization method for this domain.

Parameters

Returns

This action returns the initialization method with options < Standard | Linear | Parametric | Fit >.

$dom setInitializeMethod ?-axis point normal? method

This action sets the initialization method for this domain.

Parameters

Returns

This action returns nothing.

$dom getEllipticSolverAttribute ?-edge index? att_name ?value_type?

This action gets the named elliptic solver attribute.

Parameters

Returns

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.

Parameters

Returns

This action returns nothing.

$dom getExtrusionSolverAttribute att_name ?value_type?

This action gets the named extrusion solver attribute.

Parameters

Returns

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

$dom setExtrusionSolverAttribute att_name att_value

This action sets the named extrusion solver attribute.

Parameters

Returns

This action returns nothing.

$domain getExtrusionBoundaryCondition edge_side

This action gets the boundary condition at a given edge side.

Parameters

Returns

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.

Boundary Conditions

$domain setExtrusionBoundaryCondition edge_side boundary_condition ?splay_factor?

This action sets the boundary condition at a given connector region.

Parameters

Returns

This action returns nothing.

See Also

getExtrusionBoundaryCondition

$domain getExtrusionBoundaryConditionStepSuppression edge_side

This action gets the step suppression factor applied to the boundary condition at a given edge side.

Parameters

Returns

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.

Parameters

Returns

This action returns nothing.

$dom get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >

This attribute is the shape constraint of the structured domain.

Type

This attribute is a string with options < Free | Fixed | Database > or an explicit list of pw::DatabaseEntity objects.

Default

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.

Type

This attribute is a string with options < Closest | Linear > or an explicit normal for linear projection.  When Linear is specified the projection uses the domain’s <DefaultProjectDirection>.

Default

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.

Type

This attribute is a string with options < MultiGrid | SuccessiveOverRelaxation >.

Default

The defult for this attribute is the value in the SolverEngine default when the domain was created.

$domain get/setEllipticSolverAttribute MultiGridRelaxationFactor < factor | value >

This attribute is the relaxation factor of the multi-grid algorithm.

Type

This attribute is Default or a float with the range (0.0, 2.0].

Default

The default for this attribute is Default.

$domain get/setEllipticSolverAttribute MultiGridProlongationFactor < factor | value >

This attribute is the Prolongation factor of the multi-grid algorithm.

Type

This attribute is Default or a float with the range (0.0, 2.0].

Default

The default for this attribute is Default.

$dom get/setEllipticSolverAttribute RelaxationFactor < factor | value >

This attribute is the relaxation factor of the succesive over- relaxtion algorithm.

Type

This attribute is a string with options < Optimal | Nominal > or a float with the range (0.0, 2.0].

Default

The default for this attribute is Optimal.

$dom get/setEllipticSolverAttribute InteriorControl func

This attribute is the interior control function of a structured domain.

Type

This attribute is a string with options < ThomasMiddlecoff | Laplace | Fixed >.

Default

The default for this attribute is the value in the InteriorControl default when the domain was created.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeControl func

This attribute is the boundary control function of a structured domain Edge.

Type

This attribute is a string with options < HilgenstockWhite | StegerSorenson | None >.

Default

The default for this attribute is the value in the EdgeControl default when the domain was created.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < method | value >

This attribute is the boundary control function spacing calculation method.

Type

This attribute is a string with options < Interpolate | Current | Adjacent > or an explicit spacing value with the range (0.0, infinity).

Default

The default for this attribute is Interpolate.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < method | value >

This attribute is the boundary control function spacing blend method.

Type

This attribute is a string with options < Exponential | Linear > or an explicit decay value with the range [1, infinity).

Default

The default for this attribute is Expotential.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation method

This attribute is the boundary control function angle calculation method.

Type

This attribute is a string with options < Orthogonal | Interpolate | Current | Adjacent >.

Default

The default for this attribute is Orthogonal.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < method | value >

This attribute is the boundary control function angle blend method.

Type

This attribute is a string with options < Exponential | Linear > or an explicit decay value with the range [1, infinity).

Default

The default for this attribute is Exponential.

$dom get/setEllipticSolverAttribute ?-edge index? EdgeConstraint constraint

This attribute is the boundary constraints of the structured domain.

Type

This attribute is a string wth options < Fixed | Floating | Orthogonal >.

Default

The default for this attribute is Fixed.

$dom get/setExtrusionSolverAttribute Mode mode

This attribute is the extrusion mode of this domain.

Type

This attribute is a string with options < NormalHyperbolic | NormalAlgebraic | Path | Rotate | Translate >.

Default

The default for this attribute is NormalHyperbolic.

$dom get/setExtrusionSolverAttribute ShapeConstraint < constraint | db_list >

This attribute is the shape constraint of the extrusion.

Type

This attribute is a string with options < Free | Database >.

Default

The default for this attribute is Free.

$dom get/setExtrusionSolverAttribute StopAtHeight < Default | Off | Value >

This attribute specifies a height stop condition or disables the stop condition with Off.

Type

This attribute is a float with the range (0, inf] or < Off | Default >.

Default

The default for this attribute is Off.

This attribute specifies a max aspect ratio stop condition or disables the stop condition with “Off”.

Type

This attribute is a float with the range (0, inf] or < Off | Default >.

Default

The default for this attribute is Off.

This attribute specifies a min skew angle stop condition or disables the stop condition with “Off”.

Type

This attribute is a float with the range (0, inf] or < Off | Default >.

Default

The default for this attribute is Off.

$dom get/setExtrusionSolverAttribute StopAtPositiveSkewJacobian < Default | Off | bool >

This attribute enables / disables the positive skew jacobian stop condition.

Type

This attribute is a boolean.

Default

The default for this attribute is true.

$dom get/setExtrusionSolverAttribute StopAtZeroJacobian < Default | Off | bool >

This attribute enables / disables the zero jacobian stop condition.

Type

This attribute is a boolean.

Default

The default for this attribute is true.

$dom get/setExtrusionSolverAttribute StopAtNegativeSkewJacobian < Default | Off | bool >

This attribute enables / disables the negative skew jacobian stop condition.

Type

This attribute is a boolean.

Default

The default for this attribute is true.

$dom get/setExtrusionSolverAttribute StopAtNegativeJacobian < Default | Off | bool >

This attribute enables / disables the negative jacobian stop condition.

Type

This attribute is a boolean.

Default

The default for this attribute is true.

$dom get/setExtrusionSolverAttribute TranslateDirection < Default | value_XYZ >

This attribute is the direction vector for translate extrusion.

Type

This attribute is an xyz vector.

Default

This default for this attribute is (1, 0, 0).

$dom get/setExtrusionSolverAttribute TranslateDistance < Default | value >

This attribute is the distance for translate extrusion.

Type

This attribute is a float with the range [0, infinity).

Default

The default for this attribute is 1.0.

$dom get/setExtrusionSolverAttribute PathConnectors <con_list>

This attribute is a list of connectors for the path.

Type

Default

The default for this attribute is an empty list.

$dom getExtrusionSolverAttribute PathMaximumSteps

This attribute is the maximum number of steps available as the path extrusion is configured.

Type

This attribute is an integer.

Default

The default for this attribute is 0.

$dom get/setExtrusionSolverAttribute PathUseTangent < Default | bool >

This attribute is the flag indicating if the path extrusion should be rotated tangentally to the path connector.

Type

This attribute is a boolean.

Default

The default for this attribute is true.

$dom get/setExtrusionSolverAttribute RotateAxisStart < Default | value_XYZ >

This attribute is the intial axis vector for rotate extrusion.

Type

This attribute is an xyz vector.

Default

The default for this attribute is (0, 0, 0).

$dom get/setExtrusionSolverAttribute RotateAxisEnd < Default | value_XYZ >

This attribute is the axis’ end vector for rotate extrusion.

Type

This attribute is an xyz vector.

Default

The default for this attribute is (1, 0, 0).

$dom get/setExtrusionSolverAttribute RotateAngle < Default | value_XYZ >

This attribute is the angle (degrees) for rotational extrusion.

Type

This attribute is a float with the range [0.0, 360].

Default

The default for this attribute is 0.0.

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

Type

This attribute is a float with the range [0.0, 1.0].

Default

The default for this attribute is 0.0.

$dom get/setExtrusionSolverAttribute NormalExplicitSmoothing < Default | value >

This attribute sepcifies the explicit smoothing coefficient for the transverse direction.

Type

This attribute is Default or a float with the range [0.0, 10.0].

Default

The default for this attribute is 0.5.

This attribute sepcifies the implicit smoothing coefficient for the transverse direction.  The value should be greater than twice the NormalExplicitSmoothing value.

Type

This attribute is Default or a float with the range (0.0, infinity).

Default

The default for this attribute is 1.0.

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

Type

This attribute is Default or a float with the range (0.0, infinity).

Default

The default for this attribute is 0.0.

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

Type

THis attribute is Default or a float with the range [0.0, 1.0].

Default

The default for this attribute is 0.5.

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

Type

This attribute is a string with options < Plane | Direction >.

Default

THe default for this attribute is Plane.

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

Type

This attribute is a value_xyz vector.

Default

The default for this attribute is (0, 0, 0).

$dom get/setExtrusionSolverAttribute NormalInitialStepSize value

This attribute gets/sets the value of the first marching step size.

Type

This attribute is a float with the range (0.0, infinity).

Default

The default for this attribute is the default connector distribution begin spacing, if non-zero or 0.01.

$dom get/setExtrusionSolverAttribute NormalMaximumStepSize value

This attribute gets/sets an upper limit for the marching step size.

Type

This attribute is a float with the range [0, infinity).  0.0 means disable this limit.

Default

The default for this attribute is 0.0.

$dom get/setExtrusionSolverAttribute NormalMinimumStepSize value

This attribute gets/sets the upper limit for the marching step size.

Type

This attribute is a float with the range [0, infinity).  0.0 means disable this limit.

Default

The default for this attribute is 0.0.

$dom get/setExtrusionSolverAttribute NormalCornerFactor value

This attribute gets/sets the scale factor for reducing/increasing the local marching step size in convex/concave regions.

Type

This attribute is a float with the range [1, infinity).  The value of 1 will disable the feature.

Default

The default for this attribute is 5.0.

Information

This attribute only affects algebraic normal extrusion.

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

Type

This attribute is Default or a float with the range [0.0, 90.0].

Default

The default for this attribute is 20.0.

Information

This attribute only affects algebraic normal extrusion.

$dom get/setExtrusionSolverAttribute NormalGridAngleIterations < Default | iterations >

This attribute gets/sets the number of smoothing iterations performed on the normal direction vector.

Type

This attribute is Default or an integer with the range [0, infinity).

Default

The default for this attribute is 0.

Information

This attribute only affects algebraic normal extrusion.

$dom get/setExtrusionSolverAttribute NormalDirectionRelaxation < Default | factor >

This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the normal marching direction vector.

Type

This attribute is Default or float with the range [0.0, 1.0].

Default

The default for this attribute is 0.5.

Information

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.

Type

This attribute is Default or an integer with the range [0, infinity).

Default

The default for this attribute is 5.

Information

This attribute only affects algebraic normal extrusion.

$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxation < Default | factor >

This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the marching step size.

Type

This attribute is Default or a float with the range [0.0, 1.0].

Default

The default for this attribute is 0.7.

Information

This attribute only affects algebraic normal extrusion.

$dom get/setExtrusionSolverAttribute NormalStepSizeRelaxationIterations < Default | iterations >

This attribute gets/sets the number of smoothing iterations performed on the marching step size.

Type

This attribute is Default or an integer with the range [0, infinity).

Default

The default for this attribute is 3.

Information

This attribute only affects algebraic normal extrusion.

$dom get/setExtrusionSolverAttribute SpacingMode < Default | Algebraic | Connector >

This gets/sets the spacing configuration for the extrusion.

Type

This attribute is a string with options < Algebraic | Connector | Default >.

Default

The default for this attribute is Algebraic.

Information

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.

$dom get/setExtrusionSolverAttribute SpacingGrowthFactor value

This gets/sets how the marching step size will grow from its initial value.

Type

This attribute is a float with the range (0.0, infinity).

Default

The default is 1.10.

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

Type

This attribute is a list of subconnectors where each entry is 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 word ‘Forward’ or the word ‘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.

Default

The default for this attribute is an empty list.

See Also

setExtrusionSolverAttribute, getExtrusionSolverAttribute