pw:: DomainSubGrid

Domain subgrid type

Derives From

pw::Object

Summary
Domain subgrid type
This action gets the domain in which this is a subgrid.
This action gets the minimum ij limits of this subgrid.
This action sets the minimum ij limits of this subgrid.
This action gets the maximum ij limits of this subgrid.
This action sets the maximum ij limits of this subgrid.
This action gets the initialization method for this subgrid.
This action sets the initialization method for this subgrid.
This action gets the default projection direction for this subgrid.
This action gets all database entities the grid entity is using.
This action gets the named elliptic solver attribute.
This action sets the named elliptic solver attribute.
This attribute is the shape constraint of the structured domain.
This attribute is the shape projection method when constrained to database entities.
This attribute is the elliptic solver engine employed when smoothing a structured domain.
This attribute is the relaxation factor of the multi-grid algorithm.
This attribute is the Prolongation factor of the multi-grid algorithm.
This attribute is the relaxation factor of the succesive over- relaxtion algorithm.
This attribute is the interior control function of a structured domain.
This attribute is the boundary control function of a structured domain Edge.
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 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 a minimum ij index.

setMinimum

$subgrid setMinimum ij

This action sets the minimum ij limits of this subgrid.

Parameters

ijThis parameter is list of the minimum i and j limits.

Returns

This action returns nothing.

getMaximum

$subgrid getMaximum

This action gets the maximum ij limits of this subgrid.

Parameters

none

Returns

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

setMaximum

$subgrid setMaximum ij

This action sets the maximum ij limits of this subgrid.

Parameters

ijThis parameter is a list of the maximum i and j indices.

Returns

This action returns nothing.

getInitializeMethod

$subgrid getInitializeMethod ?-axis pointVar normalVar?

This action gets the initialization method for this subgrid.

Parameters

-axis pointVarThis parameter is a variable to receive the polar axis point.
normalVarThis parameter is a variable to receive the polar axis normal.

Returns

This action returns the initialization method; Standard | Linear | Polar | Orthogonal | Parametric | Fit.

setInitializeMethod

$subgrid setInitializeMethod ?-axis point normal? method

This action sets the initialization method for this subgrid.

Parameters

-axis pointThis parameter is the polar axis point.
normalThis parameter is the polar axis normal.
methodThis parameter is the initialization method; Standard | Linear | Polar | Orthogonal | Parametric | Fit.

Returns

This action returns nothing.

getDefaultProjectDirection

$subgrid getDefaultProjectDirection

This action gets the default projection direction for this subgrid.

Parameters

This action has no parameters.

Returns

This action returns a 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

6.948464792806903e-17 0.0 1.0

getDatabaseEntities

$entity getDatabaseEntities

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

Parameters

-solverIf this 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) 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 edge to get the attribute from.  If not given and the attribute applies to edges, 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 ?-edge index? att_name att_value

This action sets the named elliptic solver attribute.

Parameters

-edge indexThis optional parameter is the edge to set the attribute to.  If not given the attribute is applied to all edges.
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

ShapeConstraint

$subgrid get/setEllipticSolverAttribute ShapeConstraint < constraint | db_list >

This attribute is the shape constraint of the structured domain.

Type

This attribute is a string with options < Free | Fixed | Database > or an explicit list of pw::DatabaseEntity objects.

Default

The default for this attribute is Free.

ShapeProjection

$subgrid get/setEllipticSolverAttribute ShapeProjection < method | normal >

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

Type

This attribute is a string with options < Closest | Linear > or an explicit normal for linear projection.  When Linear is specified the projection uses the sub domain’s <DefaultProjectDirection>.

Default

The default for this attribute is Closest.

SolverEngine

$subgrid get/setEllipticSolverAttribute SolverEngine function

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

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::DomainStructured.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.

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

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

EdgeControl

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl func

This attribute is the boundary control function of a structured domain Edge.

Type

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

Default

The default for this attribute is the value in the EdgeControl default when the domain was created.

EdgeSpacingCalculation

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

EdgeSpacingBlend

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

EdgeAngleCalculation

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

EdgeAngleBlend

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

EdgeConstraint

$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeConstraint constraint

This attribute is the boundary constraints of the structured domain.

Type

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

Default

The default for this attribute is Fixed.

$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.
$entity getDatabaseEntities
This action gets all database entities the grid 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 < 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 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 domain.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeControl func
This attribute is the boundary control function of a structured domain Edge.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingCalculation < method | value >
This attribute is the boundary control function spacing calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeSpacingBlend < method | value >
This attribute is the boundary control function spacing blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleCalculation method
This attribute is the boundary control function angle calculation method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeAngleBlend < method | value >
This attribute is the boundary control function angle blend method.
$subgrid get/setEllipticSolverAttribute ?-edge index? EdgeConstraint constraint
This attribute is the boundary constraints of the structured domain.
Base type for all glyph types
Structured domain type
A vector is a list of float values.
Base type for all database entities
A string is an array of characters.
pw::DomainStructured get/setDefault SolverEngine function
This default is the elliptic solver engine employed when smoothing a structured domain.
A float is a fractional number.