pw:: BlockSubGrid

$subgrid getBlock

This action gets the block in which this is a subgrid.

Parameters

none

Returns

This action returns a pw::BlockStructured object.

$subgrid getMinimum

This action gets the minimum ijk limits of this subgrid.

Parameters

none

Returns

This action returns a minimum ijk index.

$subgrid setMinimum ijk

This action sets the minimum ijk limits of this subgrid.

Parameters

Returns

This action returns nothing.

$subgrid getMaximum

This action gets the maximum ijk limits of this subgrid.

Parameters

none

Returns

This action returns a list containing the maximum i, j and k indices.

$subgrid setMaximum ijk

This action sets the maximum ijk limits of this subgrid.

Parameters

Returns

This action returns nothing.

$subgrid getEllipticSolverAttribute ?-face 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.

$subgrid setEllipticSolverAttribute ?-face index? att_name att_value

This action sets the named elliptic solver attribute.

Parameters

Returns

This action returns nothing.

$subgrid get/setEllipticSolverAttribute SolverEngine function

This attribute is the elliptic solver engine employed when smoothing a structured block.

Type

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

Default

The default for this attribute is set using the current value of the default pw::BlockStructured.SolverEngine.

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

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

$subgrid get/setEllipticSolverAttribute OversetAdaptAmplification < factor | 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

Type

This attribute is Off, On (a nominal value of 1.0), or a float with the range [1.0, 10.0].

Default

The default for this attribute is Default.

$subgrid get/setUnstructuredSolverAttribute OversetAdaptTargets <targets>

This attribute sets the orphan remediation and interpolation improvement adaption targets to be applied to an structured block run in the elliptic solver.

Type

This attribute is a <string list> with options < Fringes | Donors | OrphanDonorCandidates >.

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

$subgrid get/setEllipticSolverAttribute InteriorControl func

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

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 block was created.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceControl func

This attribute is the boundary control function of a structured block face.

Type

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

Default

The default for this attribute is the value in the FaceControl default when the block was created.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < 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.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingBlend < 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.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleCalculation 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.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleBlend < 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.

$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint constraint

This attribute is the boundary constraints of the structured block.

Type

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

Default

The default for this attribute is Fixed.