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
- DomainSubGrid
- Edge
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: DomainSubGrid

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.

Derives From

pw::Object

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

Instance Actions

getDomain

$subgrid getDomain

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

Parameters

none

Returns

This action returns a pw::DomainStructured object.

getMinimum

$subgrid getMinimum

This action gets the minimum ij limits of this subgrid.

Parameters

none

Returns

This action returns the minimum ij index.

See Also

setMinimum, getMaximum, setMaximum

setMinimum

$subgrid setMinimum ij

This action sets the minimum ij limits of this subgrid.

Parameters

ijThis required parameter is the index of the minimum i and j limits.

Returns

This action returns nothing.

See Also

getMinimum, getMaximum, setMaximum

getMaximum

$subgrid getMaximum

This action gets the maximum ij limits of this subgrid.

Parameters

none

Returns

This action returns the maximum ij index.

See Also

setMaximum, setMinimum, getMinimum

setMaximum

$subgrid setMaximum ij

This action sets the maximum ij limits of this subgrid.

Parameters

ijThis required parameter is the index of the maximum i and j limits.

Returns

This action returns nothing.

See Also

getMaximum, setMinimum, getMinimum

getInitializeMethod

$subgrid getInitializeMethod ?-axis pointVar normalVar?

This action gets the initialization method for this subgrid.

Parameters

-axis pointVar normalVarThis 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.

Returns

This action returns the string initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >.

See Also

setInitializeMethod

setInitializeMethod

$subgrid setInitializeMethod ?-axis point normal? method

This action sets the initialization method for this subgrid.

Parameters

-axis point normalThis optional parameter is the polar axis point vector and normal vector.
methodThis required parameter is the string initialization method with options < Standard | Linear | Polar | Orthogonal | Parametric | Fit >.

Returns

This action returns nothing.

See Also

getInitializeMethod

getDefaultProjectDirection

$subgrid getDefaultProjectDirection

This action gets the default projection direction for this subgrid.

Parameters

This action has no parameters.

Returns

This action returns a direction vector.

Example

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

getDatabaseEntities

$subgrid getDatabaseEntities

This action gets all database entities the subgrid entity is using.

Parameters

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

Returns

This action returns a list of pw::DatabaseEntity objects.

Example

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

getEllipticSolverAttribute

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

This action gets the named elliptic solver attribute.

Parameters

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

Returns

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

See Also

setEllipticSolverAttribute

setEllipticSolverAttribute

$subgrid setEllipticSolverAttribute ?-edge index? att_name att_value

This action sets the named elliptic solver attribute.

Parameters

-edge indexThis 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_nameThis required parameter is the string name of the attribute to set.
att_valueThis required parameter is the new string, integer or float value of the attribute.

Returns

This action returns nothing.

See Also

getEllipticSolverAttribute

Elliptic Solver Attributes

ShapeConstraint

$subgrid get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >

This attribute is the shape constraint of the structured domain.

Type

A string with options < Free | Fixed | Database > or an explicit list of pw::DatabaseEntity objects.

Default

The default for this attribute is Free.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

ShapeProjection

$subgrid get/setEllipticSolverAttribute ShapeProjection < method | normal >

This attribute is the shape projection method when constrained to database entities.

Type

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.

Default

The default for this attribute is Closest.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

SolverEngine

$subgrid get/setEllipticSolverAttribute SolverEngine function

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

Type

A string with options < MultiGrid | SuccessiveOverRelaxation >.

Default

The defult for this attribute is the value in the pw::DomainStructured.SolverEngine (Default) when the subgrid was created.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

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

RelaxationFactor

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

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

Type

A string with options < Optimal | Nominal > 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 < ThomasMiddlecoff | Laplace | Fixed >

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

Type

This attribute is a string with options < ThomasMiddlecoff | Laplace | Fixed >.

Default

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

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

EdgeControl

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >

This attribute is the boundary control function of a structured subgrid edge.

Type

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

Default

The default for this attribute is the value in the pw::DomainStructured.EdgeControl (Default) default when the domain was created.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

EdgeSpacingCalculation

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < 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 spacing value in the range (0.0, infinity).

Default

The default for this attribute is Interpolate.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

EdgeSpacingBlend

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < Exponential | Linear | 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

EdgeAngleCalculation

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation < 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

EdgeAngleBlend

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

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute

EdgeConstraint

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeConstraint < Fixed | Floating | Orthogonal >

This attribute is the boundary constraints of the structured domain.

Type

A string wth options < Fixed | Floating | Orthogonal >.

Default

The default for this attribute is Fixed.

See Also

setEllipticSolverAttribute, getEllipticSolverAttribute
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
A structured domain is a computationally orthogonal surface grid bounded by exactly four edges, any of which can be degenerate in the zero dimension (pole).
$subgrid getDomain
This action gets the domain in which this is a subgrid.
$subgrid getMinimum
This action gets the minimum ij limits of this subgrid.
$subgrid setMinimum ij
This action sets the minimum ij limits of this subgrid.
$subgrid getMaximum
This action gets the maximum ij limits of this subgrid.
$subgrid setMaximum ij
This action sets the maximum ij limits of this subgrid.
$subgrid getInitializeMethod ?-axis pointVar normalVar?
This action gets the initialization method for this subgrid.
$subgrid setInitializeMethod ?-axis point normal? method
This action sets the initialization method for this subgrid.
$subgrid getDefaultProjectDirection
This action gets the default projection direction for this subgrid.
$subgrid getDatabaseEntities
This action gets all database entities the subgrid entity is using.
$subgrid getEllipticSolverAttribute ?-edge index? att_name ?value_type?
This action gets the named elliptic solver attribute.
$subgrid setEllipticSolverAttribute ?-edge index? att_name att_value
This action sets the named elliptic solver attribute.
$subgrid get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >
This attribute is the shape constraint of the structured domain.
$subgrid get/setEllipticSolverAttribute ShapeProjection < method | normal >
This attribute is the shape projection method when constrained to database entities.
$subgrid get/setEllipticSolverAttribute SolverEngine function
This attribute is the elliptic solver engine employed when smoothing a structured domain.
$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 RelaxationFactor < Optimal | Nominal | value >
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
$subgrid get/setEllipticSolverAttribute InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This attribute is the interior control function of a structured domain.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl < HilgenstockWhite | StegerSorenson | None >
This attribute is the boundary control function of a structured subgrid edge.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < Interpolate | Current | Adjacent | value >
This attribute is the boundary control function spacing calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < Exponential | Linear | value >
This attribute is the boundary control function spacing blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation < Orthogonal | Interpolate | Current | Adjacent >
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < Exponential | Linear | value >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeConstraint < Fixed | Floating | Orthogonal >
This attribute is the boundary constraints of the structured domain.
Base type for all glyph types
An index is a list of integer values.
A string is an array of characters.
A vector is a list of float values.
Base type for all database entities
An integer is a whole number.
A float is a fractional number.
pw::DomainStructured get/setDefault SolverEngine < MulitGrid | SuccessiveOverRelaxation >
This default is the elliptic solver engine employed when smoothing a structured domain.
pw::DomainStructured get/setDefault InteriorControl < ThomasMiddlecoff | Laplace | Fixed >
This default is the interior control function of a structured domain when it is created.
pw::DomainStructured get/setDefault EdgeControl < HilgenstockWhite | StegerSorenson | None >
This default is the boundary control function of all edges of a structured domain when it is created.