A block sub-grid is a computationally orthogonal, continuous subset of a pw::BlockStructured block. Its purpose is to provide finer control of grid quality in specific regions.
| pw:: | A block sub-grid is a computationally orthogonal, continuous subset of a pw::BlockStructured block. |
| Instance Actions | |
| getBlock | This action gets the block in which this is a subgrid. |
| getMinimum | This action gets the minimum ijk limits of this subgrid. |
| setMinimum | This action sets the minimum ijk limits of this subgrid. |
| getMaximum | This action gets the maximum ijk limits of this subgrid. |
| setMaximum | This action sets the maximum ijk limits of this subgrid. |
| setEllipticSolverAttribute | This action sets the named elliptic solver attribute. |
| Elliptic Solver Attributes | |
| SolverEngine | This attribute is the elliptic solver engine employed when smoothing a structured block. |
| MultiGridRelaxationFactor | This attribute is the relaxation factor of the multi-grid algorithm. |
| MultiGridProlongationFactor | This attribute is the Prolongation factor of the multi-grid algorithm. |
| OversetAdaptAmplification | This attribute sets the strength of the magnet function formed from overlapping block overset data to be applied to a structured block run in the elliptic solver |
| OversetAdaptTargets | This attribute sets the orphan remediation and interpolation improvement adaption targets to be applied to an structured block run in the elliptic solver. |
| RelaxationFactor | This attribute is the relaxation factor of the succesive over- relaxtion algorithm. |
| InteriorControl | This attribute is the interior control function of a structured block. |
| FaceControl | This attribute is the boundary control function of a structured block face. |
| FaceSpacingCalculation | This attribute is the boundary control function spacing calculation method. |
| FaceSpacingBlend | This attribute is the boundary control function spacing blend method. |
| FaceAngleCalculation | This attribute is the boundary control function angle calculation method. |
| FaceAngleBlend | This attribute is the boundary control function angle blend method. |
| FaceConstraint | This attribute is the boundary constraints of the structured block. |
$subgrid getBlock
This action gets the block in which this is a subgrid.
none
This action returns a pw::BlockStructured object.
$subgrid getMinimum
This action gets the minimum ijk limits of this subgrid.
none
This action returns the minimum ijk index.
$subgrid setMinimum ijk
This action sets the minimum ijk limits of this subgrid.
| ijk | This required parameter is the minimum ijk index of the subgrid. |
This action returns nothing.
$subgrid getMaximum
This action gets the maximum ijk limits of this subgrid.
none
This action returns the maximum ijk index of the subgrid.
$subgrid setMaximum ijk
This action sets the maximum ijk limits of this subgrid.
| ijk | This required parameter is the maximum ijk index of the subgrid. |
This action returns nothing.
$subgrid setEllipticSolverAttribute ?-face index? att_name att_value
This action sets the named elliptic solver attribute.
| -face index | This optional parameter is the integer face index to set the attribute on. If not given, the attribute will be applied to all faces. |
| att_name | This required parameter is the string name of the attribute to set. |
| att_value | This required parameter is the string, integer or float value to set for the attribute. |
This action returns nothing.
<getEllipticSolverAttribute>, pw::BlockStructured.setEllipticSolverAttribute pw::BlockStructured.getEllipticSolverAttribute
$subgrid get/setEllipticSolverAttribute SolverEngine function
This attribute is the elliptic solver engine employed when smoothing a structured block.
A string with options < MultiGrid | SuccessiveOverRelaxation >.
The default for this attribute is set using the current value of the default pw::BlockStructured.SolverEngine (Default) when the block was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>, pw::BlockStructured.SolverEngine (Default)
$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 OversetAdaptAmplification < Off | On | value >
This attribute sets the strength of the magnet function formed from overlapping block overset data to be applied to a structured block run in the elliptic solver
A string with options < Off | On > or a float in the range [1.0, 10.0], where On indicates a nominal value of 1.0.
The default for this attribute is Default.
$subgrid get/setUnstructuredSolverAttribute OversetAdaptTargets target_list
This attribute sets the orphan remediation and interpolation improvement adaption targets to be applied to an structured block run in the elliptic solver.
A list of string with options < Fringes | Donors | Orphans | OrphanDonorCandidates >.
$subgrid get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | Default | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
A string with options < Optimal | Nominal | Default > or a float in the range (0.0, 2.0].
The default for this attribute is Optimal.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid get/setEllipticSolverAttribute InteriorControl func
This attribute is the interior control function of a structured block.
A string with options < ThomasMiddlecoff | Laplace | Fixed >.
The default for this attribute is the value in the <pw::BlockStructured.InteriorControl (Default)> default when the block was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>, <pw::Block.InteriorControl (Default)>
$subgrid get/setEllipticSolverAttribute ?-face index? FaceControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function of a structured block face.
A string with options < HilgenstockWhite | StegerSorenson | None >.
The default for this attribute is the value in the pw::BlockStructured.FaceControl (Default) default when the block was created.
setEllipticSolverAttribute, <getEllipticSolverAttribute>, pw::BlockStructured.FaceControl (Default)
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing calculation method.
A string with options < Interpolate | Current | Adjacent > or an explicit float spacing value in the range (0.0, infinity).
The default for this attribute is Interpolate.
setEllipticSolverAttribute, <getEllipticSolverAttribute>
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingBlend < method | 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 ?-face index? FaceAngleCalculation < 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 ?-face index? FaceAngleBlend < 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.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint < Fixed | Floating | Adapt >
This attribute is the boundary constraints of the structured block.
This attribute is a string wth options < Fixed | Floating | Adapt >.
The default for this attribute is Fixed.
This action gets the block in which this is a subgrid.
$subgrid getBlock
This action gets the minimum ijk limits of this subgrid.
$subgrid getMinimum
This action sets the minimum ijk limits of this subgrid.
$subgrid setMinimum ijk
This action gets the maximum ijk limits of this subgrid.
$subgrid getMaximum
This action sets the maximum ijk limits of this subgrid.
$subgrid setMaximum ijk
This action sets the named elliptic solver attribute.
$subgrid setEllipticSolverAttribute ?-face index? att_name att_value
This attribute is the elliptic solver engine employed when smoothing a structured block.
$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 sets the strength of the magnet function formed from overlapping block overset data to be applied to a structured block run in the elliptic solver
$subgrid get/setEllipticSolverAttribute OversetAdaptAmplification < Off | On | value >
This attribute sets the orphan remediation and interpolation improvement adaption targets to be applied to an structured block run in the elliptic solver.
$subgrid get/setUnstructuredSolverAttribute OversetAdaptTargets target_list
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
$subgrid get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | Default | value >
This attribute is the interior control function of a structured block.
$subgrid get/setEllipticSolverAttribute InteriorControl func
This attribute is the boundary control function of a structured block face.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function spacing calculation method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing blend method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingBlend < method | value >
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleBlend < Exponential | Linear | value >
This attribute is the boundary constraints of the structured block.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint < Fixed | Floating | Adapt >
This action sets the named elliptic solver attribute.
$block setEllipticSolverAttribute ?-face <index | boundary>? att_name att_value
This action gets the named elliptic solver attribute.
$block getEllipticSolverAttribute ?-face index? att_name ?value_type?
This gets/sets the default elliptic solver engine employed when smoothing a structured block.
pw::BlockStructured get/setDefault SolverEngine < MultiGrid | SuccessiveOverRelaxation >
This gets/sets the default boundary control function of all faces of a structured block when it is created.
pw::BlockStructured get/setDefault FaceControl < HilgenstockWhite | StegerSorenson | None >