A domain sub-grid is a computationally orthogonal, continuous subset of a pw::DomainStructured domain. Its purpose is to provide finer control of grid quality in specific regions.
| pw:: | A domain sub-grid is a computationally orthogonal, continuous subset of a pw::DomainStructured domain. |
| Instance Actions | |
| getDomain | This action gets the domain in which this is a subgrid. |
| getMinimum | This action gets the minimum ij limits of this subgrid. |
| setMinimum | This action sets the minimum ij limits of this subgrid. |
| getMaximum | This action gets the maximum ij limits of this subgrid. |
| setMaximum | This action sets the maximum ij limits of this subgrid. |
| getInitializeMethod | This action gets the initialization method for this subgrid. |
| setInitializeMethod | This action sets the initialization method for this subgrid. |
| getDefaultProjectDirection | This action gets the default projection direction for this subgrid. |
| getDatabaseEntities | This action gets all database entities the subgrid entity is using. |
| setEllipticSolverAttribute | This action sets the named elliptic solver attribute. |
| 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 subgrid 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. |
$subgrid getDomain
This action gets the domain in which this is a subgrid.
none
This action returns a pw::DomainStructured object.
$subgrid getMinimum
This action gets the minimum ij limits of this subgrid.
none
This action returns the minimum ij index.
$subgrid setMinimum ij
This action sets the minimum ij limits of this subgrid.
| ij | This required parameter is the index of the minimum i and j limits. |
This action returns nothing.
$subgrid getMaximum
This action gets the maximum ij limits of this subgrid.
none
This action returns the maximum ij index.
$subgrid setMaximum ij
This action sets the maximum ij limits of this subgrid.
| ij | This required parameter is the index of the maximum i and j limits. |
This action returns nothing.
$subgrid getInitializeMethod ?-axis pointVar normalVar?
This action gets the initialization method for this subgrid.
| -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 >.
$subgrid setInitializeMethod ?-axis point normal? method
This action sets the initialization method for this subgrid.
| -axis point normal | This optional parameter is the polar axis point vector and normal vector. |
| method | This required parameter is the string initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >. |
This action returns nothing.
$subgrid getDefaultProjectDirection
This action gets the default projection direction for this subgrid.
This action has no parameters.
This action returns a direction vector.
This example shows how to get the default projection direction for the given subgrid. $subgrid is referencing an existing domain subgrid.
Code
puts [$subgrid getDefaultProjectDirection]
Output
0.0 0.0 1.0
$subgrid getDatabaseEntities
This action gets all database entities the subgrid entity is using.
| -solver | If this optional flag is specified, the command restricts the list of of database entities to those that are suitable for use in the grid solver. This may be different from the list of entities explicitly specified via the solver attribute commands. |
This action returns a list of pw::DatabaseEntity objects.
This example shows how to get the number of database entities the given grid entity is using. $dom(1) is referencing an existing domain.
Code
puts [llength [[$dom(1) getSubGrid 1] getDatabaseEntities]]
Output
2
$subgrid 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.
<getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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::DomainSubGrid.getDefaultProjectDirection.
The default for this attribute is Closest.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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 pw::DomainStructured.SolverEngine (Default) when the subgrid was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid get/setEllipticSolverAttribute MultiGridRelaxationFactor < Default | value >
This attribute is the relaxation factor of the multi-grid algorithm.
A string with the value < Default > or a float in the range (0.0, 2.0].
The default for this attribute is Default.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid get/setEllipticSolverAttribute MultiGridProlongationFactor < Default | value >
This attribute is the Prolongation factor of the multi-grid algorithm.
A string with the value < Default > or a float in the range (0.0, 2.0].
The default for this attribute is Default.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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 <pw::DomainStructured.InteriorControl (Default)> default when the domain was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function of a structured subgrid edge.
A string with options < HilgenstockWhite | StegerSorenson | None >.
The default for this attribute is the value in the pw::DomainStructured.EdgeControl (Default) default when the domain was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid 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.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
This action gets the domain in which this is a subgrid.
$subgrid getDomain
This action gets the minimum ij limits of this subgrid.
$subgrid getMinimum
This action sets the minimum ij limits of this subgrid.
$subgrid setMinimum ij
This action gets the maximum ij limits of this subgrid.
$subgrid getMaximum
This action sets the maximum ij limits of this subgrid.
$subgrid setMaximum ij
This action gets the initialization method for this subgrid.
$subgrid getInitializeMethod ?-axis pointVar normalVar?
This action sets the initialization method for this subgrid.
$subgrid setInitializeMethod ?-axis point normal? method
This action gets the default projection direction for this subgrid.
$subgrid getDefaultProjectDirection
This action gets all database entities the subgrid entity is using.
$subgrid getDatabaseEntities
This action sets the named elliptic solver attribute.
$subgrid setEllipticSolverAttribute ?-edge index? att_name att_value
This attribute is the shape constraint of the structured domain.
$subgrid get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >
This attribute is the shape projection method when constrained to database entities.
$subgrid get/setEllipticSolverAttribute ShapeProjection < method | normal >
This attribute is the elliptic solver engine employed when smoothing a structured domain.
$subgrid get/setEllipticSolverAttribute SolverEngine function
This attribute is the relaxation factor of the multi-grid algorithm.
$subgrid get/setEllipticSolverAttribute MultiGridRelaxationFactor < Default | value >
This attribute is the Prolongation factor of the multi-grid algorithm.
$subgrid get/setEllipticSolverAttribute MultiGridProlongationFactor < Default | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
$subgrid get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | value >
This attribute is the interior control function of a structured domain.
$subgrid get/setEllipticSolverAttribute InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This attribute is the boundary control function of a structured subgrid edge.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function spacing calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < Exponential | Linear | value >
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < Exponential | Linear | value >
This attribute is the boundary constraints of the structured domain.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeConstraint < Fixed | Floating | Orthogonal >
This default is the elliptic solver engine employed when smoothing a structured domain.
pw::DomainStructured get/setDefault SolverEngine < MulitGrid | SuccessiveOverRelaxation >
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 >