Glyph Version 7.22.2 |
pw:: DomainStructuredA structured domain is a computationally orthogonal surface grid bounded by exactly four edges, any of which can be degenerate in the zero dimension (pole). Derives Frompw::Object pw::Entity pw::GridEntity pw::Domain Summary
create
This action creates a new structured domain object. ParametersThis action has no parameters. ReturnsThis action returns a new pw::DomainStructured object, with no edges or interior points. See AlsocreateOnDatabase, createFromConnectors, createFromPoints, pw::Domain.addEdge createOnDatabase
This action creates new structured domain objects on the given database entities. Parameters
ReturnsThis action returns a list of new pw::DomainStructured objects. InformationThis command supports progress updates. See AlsocreateFromConnectors
This action creates new structured domain objects from the given connectors. Parameters
ReturnsThis action returns a list of new pw::DomainStructured objects. InformationThis command supports progress updates. See Alsocreate, createFromPoints, createOnDatabase, pw::Edge.create, pw::Edge.addConnector, pw::Domain.addEdge, pw::Creator NotesWhile this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input 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. createFromPoints
This action, given a list of lists of xyz vector values or database-constrained points, creates a new domain. Parameters
ReturnsThis 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. See Alsocreate, createFromConnectors, createOnDatabase ExampleThis example creates a structured domain from list of lists of XYZ vector values. Code package require PWI_Glyph 3.18.3 Output Dimension (5 7) join
This action joins as many of the given structured domains together as possible. Parameters
ReturnsThis 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. InformationThis command supports progress updates. qualifyEdges
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
ReturnsThis action returns a boolean, true if a valid set of edges. getOverlappingDomains
This action will get the domains that share corners with the edges passed in. Parameters
ReturnsThis action returns a list of the pw::DomainStructured objects that overlap with the domain that would be created from 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. Parameters
ReturnsThis action returns a list of pw::Connector objects to continue the domain edge definition (may be an empty list). getDomainsFromDatabase
This action gets a list of domains that are constrained to the given databases. Parameters
ReturnsThis action returns a list of pw::Domain objects. ExampleThis 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 \ getDomainSubGridsFromDatabase
This action gets a list of subgrids that are constrained to the given databases. Parameters
ReturnsThis action returns a list of pw::DomainSubGrid objects. ExampleThis 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 \ InteriorControl (Default)
This default is the interior control function of a structured domain when it is created. TypeA string with options < ThomasMiddlecoff | Laplace | Fixed >. DefaultThe default value is ThomasMiddlecoff. See AlsoEdgeControl (Default)
This default is the boundary control function of all edges of a structured domain when it is created. TypeA string with options < HilgenstockWhite | StegerSorenson | None >. DefaultThe default value is HilgenstockWhite. See AlsoSolverEngine (Default)
This default is the elliptic solver engine employed when smoothing a structured domain. TypeA string with options < MultiGrid | SuccessiveOverRelaxation >. DefaultThe default value is MultiGrid. See AlsogetPoint
This action gets the position of a domain grid point. Parameters
InformationEither index or ij_index parameter must be specified. ReturnsThis action returns a point giving the grid point position (may be in the form “u v dbentity”). setPoint
This action sets the position of a domain interior grid point. Parameters
InformationEither index or ij_index parameter must be specified. ReturnsThis action returns nothing. isInteriorIndex
This action checks to see if an index corresponds to a point in the interior of the domain. Parameters
InformationEither index or ij_index parameter must be specified. ReturnsThis action returns true if the index is an interior point. getPosition
This action gets the position in the defining space of the domain at the given index. Parameters
ReturnsThis action returns a point giving the position on the domain (may be in the form “u v dbentity”). getXYZ
This action gets the position of the domain in model space at the given index. Parameters
ReturnsThis action returns an XYZ vector. getCell
This action gets the indices of the given cell. Parameters
InformationEither index or ij_index must be specified. ReturnsThis 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. NotesCollaped (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. getCellsUsingIndex
Returns the indices of the cells whose connectivity includes the specified index. Parameters
InformationEither index or ij_index parameter must be specified. ReturnsThis 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. getXYZsAtIndex
This action gets a line of points in the given direction at the given index. Parameters
ReturnsThis action returns a list of XYZ vectors. createSubGrid
This action creates a subgrid on this domain. Parameters
ReturnsThis action returns a new pw::DomainSubGrid object. getSubGridCount
This action gets the number of subgrids in this domain. ParametersThis action has no parameters. ReturnsThis action returns the integer number of subgrids. getSubGrid
This action gets the subgrid at the given index. Parameters
ReturnsThis action returns a pw::DomainSubGrid object. getSubGrids
This action gets the subgrid list. ParametersThis action has no parameters. ReturnsThis action returns a pw::DomainSubGrid object list. removeSubGrid
This action removes the subgrid from the domain. Parameters
InformationEither index or subgrid must be specified. ReturnsThis action returns nothing. getEllipticSolverResidual
This action gets the last elliptic solver residual info for the domain/subgrid at the given index. Parameters
ReturnsThis action returns nothing. Data ArrayThe data array variable will contain the following elements:
ExampleThis example shows how to get the last elliptic solver residual info for a domain refenced by $domain. Code $domain getEllipticSolverResidual residInfo getEdge
This action gets the edge at the given index or computational boundary. Parameters
ReturnsThis action returns a pw::Edge object. InformationEither the edge index or computational boundary must be specified. project
This action projects this domain onto one or more database entities. Parameters
ReturnsThis action returns nothing. See Alsopw::Domain.getDefaultProjectDirection ExampleThis 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) split
This action splits this domain in the given direction at the given indices. Parameters
ReturnsThis action returns a list of pw::DomainStructured objects. InformationAny duplicate indices will be ignored, as well as indices at the limits of the domain. join
This action joins the given domain to this domain. Parameters
ReturnsThis action returns nothing. InformationThe 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. setOrientation
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
ReturnsThis action returns nothing. InformationFor 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. alignOrientation
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
ReturnsThis action returns nothing. canReExtrude
This action returns true if the entity can be re-extruded. Parametersnone ReturnsThis action returns a boolean value indicating if the entity can be re-extruded. ExampleThis example shows how to get a list of all entities that can be re-extruded. Code puts "Entities valid for re-extrusion:" triangulate
This action creates an unstructured domain by triangulating this domain. Parameters
ReturnsThis action returns a pw::DomainUnstructured object. InformationThe different methods have the following behavoir:
getInitializeMethod
This action gets the initialization method for this domain. Parameters
ReturnsThis action returns the string initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >. See AlsosetInitializeMethod
This action sets the initialization method for this domain. Parameters
ReturnsThis action returns nothing. See AlsogetEllipticSolverAttribute
This action gets the named elliptic solver attribute. Parameters
ReturnsThis action returns the actual or default value of the attribute. See AlsosetEllipticSolverAttribute
This action sets the named elliptic solver attribute. Parameters
ReturnsThis action returns nothing. See AlsogetExtrusionSolverAttribute
This action gets the named extrusion solver attribute. Parameters
ReturnsThis action returns the actual or default string, integer or float value of the attribute. See AlsosetExtrusionSolverAttribute
This action sets the named extrusion solver attribute. Parameters
See AlsoReturnsThis action returns nothing. getExtrusionBoundaryCondition
This action gets the boundary condition at a given edge side. Parameters
ReturnsThis 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
See AlsosetExtrusionBoundaryCondition
This action sets the boundary condition at a given connector region. Parameters
ReturnsThis action returns nothing. See AlsogetExtrusionBoundaryConditionStepSuppression
This action gets the step suppression factor applied to the boundary condition at a given edge side. Parameters
ReturnsThis action returns the value of the edge suppression applied upon the requested side. See AlsosetExtrusionBoundaryConditionStepSuppression
This action sets the step suppression factor applied to the boundary condition at a given edge side. Parameters
ReturnsThis action returns nothing. See AlsoShapeConstraint
This attribute is the shape constraint of the structured domain. TypeA string with options < Free | Fixed | Database > or an explicit list of pw::DatabaseEntity objects. DefaultThe default for this attribute is Free. See AlsoShapeProjection
This attribute is the shape projection method when constrained to database entities. TypeA 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. DefaultThe default for this attribute is Closest. See AlsoSolverEngine
This attribute is the elliptic solver engine employed when smoothing a structured domain. TypeA string with options < MultiGrid | SuccessiveOverRelaxation >. DefaultThe defult for this attribute is the value in the SolverEngine (Default) when the domain was created. See AlsosetEllipticSolverAttribute, getEllipticSolverAttribute, SolverEngine MultiGridRelaxationFactorMultiGridProlongationFactorRelaxationFactor
This attribute is the relaxation factor of the succesive over- relaxtion algorithm. TypeA string with options < Optimal | Nominal > or a float in the range (0.0, 2.0]. DefaultThe default for this attribute is Optimal. See AlsoInteriorControl
This attribute is the interior control function of a structured domain. TypeThis attribute is a string with options < ThomasMiddlecoff | Laplace | Fixed >. DefaultThe default for this attribute is the value in the InteriorControl (Default) default when the domain was created. See AlsosetEllipticSolverAttribute, getEllipticSolverAttribute, InteriorControl (Default) EdgeControl
This attribute is the boundary control function of a structured domain Edge. TypeA string with options < HilgenstockWhite | StegerSorenson | None >. DefaultThe default for this attribute is the value in the EdgeControl (Default) default when the domain was created. See AlsosetEllipticSolverAttribute, getEllipticSolverAttribute, EdgeControl (Default) EdgeSpacingCalculation
This attribute is the boundary control function spacing calculation method. TypeA string with options < Interpolate | Current | Adjacent > or an explicit spacing value in the range (0.0, infinity). DefaultThe default for this attribute is Interpolate. See AlsoEdgeSpacingBlend
This attribute is the boundary control function spacing blend method. TypeA string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity). DefaultThe default for this attribute is Exponential. See AlsoEdgeAngleCalculation
This attribute is the boundary control function angle calculation method. TypeA string with options < Orthogonal | Interpolate | Current | Adjacent >. DefaultThe default for this attribute is Orthogonal. See AlsoEdgeAngleBlend
This attribute is the boundary control function angle blend method. TypeA string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity). DefaultThe default for this attribute is Exponential. See AlsoEdgeConstraint
This attribute is the boundary constraints of the structured domain. TypeA string wth options < Fixed | Floating | Orthogonal >. DefaultThe default for this attribute is Fixed. See AlsoMode
This attribute is the extrusion mode of this domain. TypeA string with options < NormalHyperbolic | NormalAlgebraic | Path | Rotate | Translate >. DefaultThe default for this attribute is NormalHyperbolic. See AlsoShapeConstraint
This attribute is the shape constraint of the extrusion. TypeA string with options < Free | Database >. If Database is specified, a list of surface-like pw::DatabaseEntity objects must follow. DefaultThe default for this attribute is Free. See AlsoStopAtHeight
This attribute specifies a height stop condition or disables the stop condition with Off. TypeA float in the range (0, infinity] or a string with options < Off | Default > where Off disables the total height stop condition. DefaultThe default for this attribute is Off. See AlsoStopAtAspectRatioStopAtPositiveSkewJacobian
This attribute enables / disables the positive skew Jacobian stop condition. TypeA 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. DefaultThe default for this attribute is true. See AlsoStopAtZeroJacobian
This attribute enables / disables the zero Jacobian stop condition. TypeA 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. DefaultThe default for this attribute is true. See AlsoStopAtNegativeSkewJacobian
This attribute enables / disables the negative skew Jacobian stop condition. TypeA 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. DefaultThe default for this attribute is true. See AlsoStopAtNegativeJacobian
This attribute enables / disables the negative Jacobian stop condition. TypeA boolean where true indicates that the negative Jacobian stop condition is applied. DefaultThe default for this attribute is true. See AlsoTranslateDirection
This attribute is the direction vector for translate extrusion. TypeA normalized direction vector. DefaultThis default for this attribute is (1, 0, 0). See AlsoTranslateDistance
This attribute is the distance for translate extrusion. TypeA float in the range [0, infinity). DefaultThe default for this attribute is 1.0. See AlsoPathConnectors
This attribute is a list of connectors for the path. TypeA 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. DefaultThe default for this attribute is an empty list. See AlsoPathMaximumSteps
This attribute is the maximum number of steps available as the path extrusion is configured. TypeAn integer indicating the maximum number of path steps to extrude. DefaultThe default for this attribute is 0. See AlsoPathUseTangent
This attribute is the flag indicating if the path extrusion should be rotated tangentially to the path connector. TypeA boolean where true indicates that the path extrusion should be rotated tangentially to the path connector. DefaultThe default for this attribute is true. See AlsoRotateAngle
This attribute is the angle (degrees) for rotational extrusion. TypeA float in the range [0.0, 360]. DefaultThe default for this attribute is 0.0. See AlsoNormalAspectRatio
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. TypeA float in the range [0.0, 1.0]. DefaultThe default for this attribute is 0.0. See AlsoNormalExplicitSmoothingNormalImplicitSmoothingThis attribute sepcifies the implicit smoothing coefficient for the transverse direction. The value should be greater than twice the NormalExplicitSmoothing value. TypeA string with the value < Default > or a float in the range (0.0, infinity). DefaultThe default for this attribute is 1.0. See AlsoNormalKinseyBarthSmoothing
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. TypeA string with the value < Default > or a float in the range (0.0, infinity). DefaultThe default for this attribute is 0.0. See AlsoNormalVolumeSmoothing
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. TypeA string with the value < Default > or a float in the range [0.0, 1.0]. DefaultThe default for this attribute is 0.5. See AlsoNormalMarchingMode
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. TypeA string with options < Plane | Direction >. DefaultThe default for this attribute is Plane. See AlsoNormalMarchingVector
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. TypeA direction vector. DefaultThe default for this attribute is (0, 0, 0). See AlsoNormalInitialStepSize
This attribute gets/sets the value of the first marching step size. TypeA float in the range (0.0, infinity). DefaultThe default for this attribute is the default connector distribution begin spacing, if non-zero or 0.01. See AlsoNormalMaximumStepSize
This attribute gets/sets an upper limit for the marching step size. TypeA float in the range [0, infinity). 0.0 means disable this limit. DefaultThe default for this attribute is 0.0. See AlsoNormalMinimumStepSize
This attribute gets/sets the upper limit for the marching step size. TypeA float in the range [0, infinity). 0.0 means disable this limit. DefaultThe default for this attribute is 0.0. See AlsoNormalCornerFactor
This attribute gets/sets the scale factor for reducing/increasing the local marching step size in convex/concave regions. TypeA float in the range [1, infinity). The value 1.0 will disable the feature. DefaultThe default for this attribute is 5.0. InformationThis attribute only affects algebraic normal extrusion. See AlsoNormalGridAngle
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). TypeA string with the value < Default > or A float in the range [0.0, 90.0]. DefaultThe default for this attribute is 20.0. InformationThis attribute only affects algebraic normal extrusion. See AlsoNormalGridAngleIterations
This attribute gets/sets the number of smoothing iterations performed on the normal direction vector. TypeA string with the value < Default > or an integer in the range [0, infinity). DefaultThe default for this attribute is 0. InformationThis attribute only affects algebraic normal extrusion. See AlsoNormalDirectionRelaxation
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the normal marching direction vector. TypeA string with the value < Default > or float in the range [0.0, 1.0]. DefaultThe default for this attribute is 0.5. InformationSee AlsosetExtrusionSolverAttribute, getExtrusionSolverAttribute This attribute only affects algebraic normal extrusion. NormalDirectionRelaxationIterations
This attribute gets/sets the number of smoothing iterations performed on the normal marching direction vector. TypeA string with the value < Default > or an integer in the range [0, infinity). DefaultThe default for this attribute is 5. InformationThis attribute only affects algebraic normal extrusion. See AlsoNormalStepSizeRelaxation
This attribute gets/sets the relaxation factor for the local Laplacian smoothing of the marching step size. TypeA string with the value < Default > or a float in the range [0.0, 1.0]. DefaultThe default for this attribute is 0.7. InformationThis attribute only affects algebraic normal extrusion. See AlsoNormalStepSizeRelaxationIterations
This attribute gets/sets the number of smoothing iterations performed on the marching step size. TypeA string with the value < Default > or an integer in the range [0, infinity). Default: The default for this attribute is 3. InformationThis attribute only affects algebraic normal extrusion. See AlsoSpacingMode
This gets/sets the spacing configuration for the extrusion. TypeA string with options < Algebraic | Connector | Default >. DefaultThe default for this attribute is Algebraic. InformationThe 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. See AlsoSpacingGrowthFactor
This gets/sets how the marching step size will grow from its initial value. TypeA float in the range (0.0, infinity). DefaultThe default is 1.10. See AlsoSpacingConnectors
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. TypeA 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. DefaultThe default for this attribute is an empty list. See AlsosetExtrusionSolverAttribute, getExtrusionSolverAttribute ExampleThis 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]] |
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 interior control function of a structured domain when it is created.
pw::DomainStructured get/setDefault InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
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 gets the named extrusion solver attribute.
$dom getExtrusionSolverAttribute att_name ?value_type?
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 >.