Glyph
Version 7.22.2
About
Base Type
Global Types
General Types
Mode Types
Base Entity Type
Database Entity Types
Grid Entity Types
Source Entity Types
Segment Types
Connector Support Types
Domain Support Types
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: BlockSubGrid

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.

Derives From

pw::Object

Summary
pw:: BlockSubGrid
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.
getEllipticSolverAttribute
This action gets the named elliptic solver attribute.
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.

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 the minimum ijk index.

See Also

setMinimum, setMaximum, getMaximum

setMinimum

$subgrid setMinimum ijk

This action sets the minimum ijk limits of this subgrid.

Parameters

ijkThis required parameter is the minimum ijk index of the subgrid.

Returns

This action returns nothing.

See Also

getMinimum, setMaximum, getMaximum

getMaximum

$subgrid getMaximum

This action gets the maximum ijk limits of this subgrid.

Parameters

none

Returns

This action returns the maximum ijk index of the subgrid.

See Also

setMaximum, setMinimum, getMinimum

setMaximum

$subgrid setMaximum ijk

This action sets the maximum ijk limits of this subgrid.

Parameters

ijkThis required parameter is the maximum ijk index of the subgrid.

Returns

This action returns nothing.

See Also

getMaximum, setMinimum, getMinimum

getEllipticSolverAttribute

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

This action gets the named elliptic solver attribute.

Parameters

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

Returns

This action returns the actual or default string, integer or float value of the attribute.

See Also

setEllipticSolverAttribute, pw::BlockStructured.setEllipticSolverAttribute pw::BlockStructured.getEllipticSolverAttribute

setEllipticSolverAttribute

$subgrid setEllipticSolverAttribute ?-face index? att_name att_value

This action sets the named elliptic solver attribute.

Parameters

-face indexThis optional parameter is the integer face index to set the attribute on.  If not given, the attribute will be applied to all faces.
att_nameThis required parameter is the string name of the attribute to set.
att_valueThis required parameter is the string, integer or float value to set for the attribute.

Returns

This action returns nothing.

See Also

getEllipticSolverAttribute, pw::BlockStructured.setEllipticSolverAttribute pw::BlockStructured.getEllipticSolverAttribute

Elliptic Solver Attributes

SolverEngine

$subgrid get/setEllipticSolverAttribute SolverEngine function

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

Type

A string with options < MultiGrid | SuccessiveOverRelaxation >.

Default

The default for this attribute is set using the current value of the default pw::BlockStructured.SolverEngine (Default) when the block was created.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute, pw::BlockStructured.SolverEngine (Default)

MultiGridRelaxationFactor

$subgrid get/setEllipticSolverAttribute MultiGridRelaxationFactor < Default | value >

This attribute is the relaxation factor of the multi-grid algorithm.

Type

A string with the value < Default > or a float in the range (0.0, 2.0].

Default

The default for this attribute is Default.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

MultiGridProlongationFactor

$subgrid get/setEllipticSolverAttribute MultiGridProlongationFactor < Default | value >

This attribute is the Prolongation factor of the multi-grid algorithm.

Type

A string with the value < Default > or a float in the range (0.0, 2.0].

Default

The default for this attribute is Default.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

OversetAdaptAmplification

$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

Type

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.

Default

The default for this attribute is Default.

OversetAdaptTargets

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

Type

A list of string with options < Fringes | Donors | Orphans | OrphanDonorCandidates >.

RelaxationFactor

$subgrid get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | Default | value >

This attribute is the relaxation factor of the succesive over- relaxtion algorithm.

Type

A string with options < Optimal | Nominal | Default > or a float in the range (0.0, 2.0].

Default

The default for this attribute is Optimal.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

InteriorControl

$subgrid get/setEllipticSolverAttribute InteriorControl func

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

Type

A string with options < ThomasMiddlecoff | Laplace | Fixed >.

Default

The default for this attribute is the value in the pw::BlockStructured.InteriorControl (Default) default when the block was created.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute, <pw::Block.InteriorControl (Default)>

FaceControl

$subgrid get/setEllipticSolverAttribute ?-face index? FaceControl < HilgenstockWhite | StegerSorenson | None >

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

Type

A string with options < HilgenstockWhite | StegerSorenson | None >.

Default

The default for this attribute is the value in the pw::BlockStructured.FaceControl (Default) default when the block was created.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute, pw::BlockStructured.FaceControl (Default)

FaceSpacingCalculation

$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < Interpolate | Current | Adjacent | value >

This attribute is the boundary control function spacing calculation method.

Type

A string with options < Interpolate | Current | Adjacent > or an explicit float spacing value in the range (0.0, infinity).

Default

The default for this attribute is Interpolate.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

FaceSpacingBlend

$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingBlend < method | value >

This attribute is the boundary control function spacing blend method.

Type

A string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity).

Default

The default for this attribute is Exponential.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

FaceAngleCalculation

$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >

This attribute is the boundary control function angle calculation method.

Type

A string with options < Orthogonal | Interpolate | Current | Adjacent >.

Default

The default for this attribute is Orthogonal.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

FaceAngleBlend

$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleBlend < Exponential | Linear | value >

This attribute is the boundary control function angle blend method.

Type

A string with options < Exponential | Linear > or an explicit float decay value in the range [1, infinity).

Default

The default for this attribute is Exponential.

FaceConstraint

$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint < Fixed | Floating | Adapt >

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.
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
A structured block is a computationally orthogonal volume grid, bounded by exactly six pw::FaceStructured faces, any of which can be degenerate in one (line) or zero (pole) dimensions.
$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 < Default | value >
This attribute is the relaxation factor of the multi-grid algorithm.
$subgrid get/setEllipticSolverAttribute MultiGridProlongationFactor < Default | value >
This attribute is the Prolongation factor of the multi-grid algorithm.
$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
$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.
$subgrid get/setEllipticSolverAttribute RelaxationFactor < Optimal | Nominal | Default | 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 < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function of a structured block face.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceSpacingCalculation < Interpolate | Current | Adjacent | 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 < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceAngleBlend < Exponential | Linear | value >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-face index? FaceConstraint < Fixed | Floating | Adapt >
This attribute is the boundary constraints of the structured block.
Base type for all glyph types
An index is a list of integer values.
An integer is a whole number.
A string is an array of characters.
A float is a fractional number.
$block setEllipticSolverAttribute ?-face <index | boundary>? att_name att_value
This action sets the named elliptic solver attribute.
$block getEllipticSolverAttribute ?-face index? att_name ?value_type?
This action gets the named elliptic solver attribute.
pw::BlockStructured get/setDefault SolverEngine < MultiGrid | SuccessiveOverRelaxation >
This gets/sets the default elliptic solver engine employed when smoothing a structured block.
pw::BlockStructured get/setDefault InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This gets/sets the default interior control function of a structured block when it is created.
pw::BlockStructured get/setDefault FaceControl < HilgenstockWhite | StegerSorenson | None >
This gets/sets the default boundary control function of all faces of a structured block when it is created.