pw:: BlockSubGrid

Block subgrid type

Derives From

pw::Object

Summary
Block subgrid type
This action gets the block in which this is a subgrid.
This action gets the minimum ijk limits of this subgrid.
This action sets the minimum ijk limits of this subgrid.
This action gets the maximum ijk limits of this subgrid.
This action sets the maximum ijk limits of this subgrid.
This action gets the named elliptic solver attribute.
This action sets the named elliptic solver attribute.
This attribute is the elliptic solver engine employed when smoothing a structured block.
This attribute is the relaxation factor of the multi-grid algorithm.
This attribute is the Prolongation factor of the multi-grid algorithm.
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
This attribute sets the orphan remediation and interpolation improvement adaption targets to be applied to an structured block run in the elliptic solver.
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
This attribute is the interior control function of a structured block.
This attribute is the boundary control function of a structured block face.
This attribute is the boundary control function spacing calculation method.
This attribute is the boundary control function spacing blend method.
This attribute is the boundary control function angle calculation method.
This attribute is the boundary control function angle blend method.
This attribute is the boundary constraints of the structured block.

Instance Actions

getBlock

$subgrid getBlock

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

Parameters

none

Returns

This action returns a pw::BlockStructured object.

getMinimum

$subgrid getMinimum

This action gets the minimum ijk limits of this subgrid.

Parameters

none

Returns

This action returns a minimum ijk index.

setMinimum

$subgrid setMinimum ijk

This action sets the minimum ijk limits of this subgrid.

Parameters

ijkThis parameter is list of the minimum i, j and k limits.

Returns

This action returns nothing.

getMaximum

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

setMaximum

$subgrid setMaximum ijk

This action sets the maximum ijk limits of this subgrid.

Parameters

ijkThis parameter is a list of the maximum i, j and k indices.

Returns

This action returns nothing.

getEllipticSolverAttribute

$subgrid getEllipticSolverAttribute ?-face index? att_name ?value_type?

This action gets the named elliptic solver attribute.

Parameters

-face indexThis optional parameter is the face to get the attribute from.  If not given and the attribute applies to faces, a list of attributes will be returned.
att_nameThis parameter is the name of the attribute to get.
value_typeThis parameter is the type string of value to get; < Actual | Default >.

Returns

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

setEllipticSolverAttribute

$subgrid setEllipticSolverAttribute ?-face index? att_name att_value

This action sets the named elliptic solver attribute.

Parameters

-face indexThis optional parameter is the face to set the attribute to.  If not given the attribute is applied to all faces.
att_nameThis parameter is the name of the attribute to set.
att_valueThis parameter is the value to set the attribute to set.

Returns

This action returns nothing.

Elliptic Solver Attributes

SolverEngine

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

MultiGridRelaxationFactor

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

MultiGridProlongationFactor

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

OversetAdaptAmplification

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

OversetAdaptTargets

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

RelaxationFactor

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

InteriorControl

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

FaceControl

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

FaceSpacingCalculation

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

FaceSpacingBlend

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

FaceAngleCalculation

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

FaceAngleBlend

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

FaceConstraint

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

Default

The default for this attribute is Fixed.

$subgrid getBlock
This action gets the block in which this is a subgrid.
$subgrid getMinimum
This action gets the minimum ijk limits of this subgrid.
$subgrid setMinimum ijk
This action sets the minimum ijk limits of this subgrid.
$subgrid getMaximum
This action gets the maximum ijk limits of this subgrid.
$subgrid setMaximum ijk
This action sets the maximum ijk limits of this subgrid.
$subgrid getEllipticSolverAttribute ?-face index? att_name ?value_type?
This action gets the named elliptic solver attribute.
$subgrid setEllipticSolverAttribute ?-face index? att_name att_value
This action sets the named elliptic solver attribute.
$subgrid get/setEllipticSolverAttribute SolverEngine function
This attribute is the elliptic solver engine employed when smoothing a structured block.
$subgrid get/setEllipticSolverAttribute MultiGridRelaxationFactor < factor | value >
This attribute is the relaxation factor of the multi-grid algorithm.
$subgrid get/setEllipticSolverAttribute MultiGridProlongationFactor < factor | value >
This attribute is the Prolongation factor of the multi-grid algorithm.
$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
$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.
$subgrid get/setEllipticSolverAttribute RelaxationFactor < factor | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
$subgrid get/setEllipticSolverAttribute InteriorControl func
This attribute is the interior control function of a structured block.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceControl func
This attribute is the boundary control function of a structured block face.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < method | value >
This attribute is the boundary control function spacing calculation method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingBlend < method | value >
This attribute is the boundary control function spacing blend method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleCalculation method
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleBlend < method | value >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint constraint
This attribute is the boundary constraints of the structured block.
Base type for all glyph types
Structured block type
A string is an array of characters.
pw::BlockStructured get/setDefault SolverEngine < MultiGrid | SuccessiveOverRelaxation >
This gets/sets the default elliptic solver engine employed when smoothing a structured block.
A float is a fractional number.