pw::EllipticSolver

The elliptic solver mode type

Derives From

pw::Object pw::Mode pw::Solver

Notes

To create a mode of this type, use the pw::Application.begin command with the mode EllipticSolver specified, like this:

set solver [pw::Application begin EllipticSolver $entities]
Summary
pw::EllipticSolverThe elliptic solver mode type
Instance Actions
runThis action runs the extrusion solver.
projectThis action projects the domains in the solver to the databases.
getActiveSubGridsThis action gets the active subgrids in the solver for a given entity.
setActiveSubGridsThis action sets the active subgrids in the solver for a given entity.

Instance Actions

run

$solver run ?-entities ents? ?Initialize | steps?

This action runs the extrusion solver.

Parameters

-entities entsThis optional parameter is a subset of the entities in the solver mode to extrude.  If this parameter is not given the solver will be run on all the entities of the solver mode.
InitializeThe optional string mode.
stepsThe optional integer number of steps to extrude.  Default is 1.

Returns

This action returns nothing.

Information

This command supports progress updates.  Unlike most commands that support progress updates, if the user aborts this command, instead of reverting to the previous state the entities being solved will be left as is.

Example

Code

$solver run Initialize  ;# rebuild interior points
$solver run 5           ;# run 5 elliptic solver steps

See also pw.Solver

project

$solver project

This action projects the domains in the solver to the databases.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Note

If this elliptic solver is running on blocks, it does nothing.

getActiveSubGrids

$solver getActiveSubGrids entity

This action gets the active subgrids in the solver for a given entity.

Parameters

entityThis parameter is a pw::DomainStructured or pw::BlockStructured object that is in the solver to get the active subgrids of.

Returns

This action returns a list of pw::DomainSubGrid or pw::BlockSubGrid objects depending on the type of the given entity.  If the list returned is empty, it means that the solver will run over the entire entity.

setActiveSubGrids

$solver setActiveSubGrids entity ?subgrids?

This action sets the active subgrids in the solver for a given entity.

Parameters

entityThis parameter is a pw::DomainStructured or pw::BlockStructured object that is in the solver.
subgridsThis optional parameter is a list of pw::DomainSubGrid or pw::BlockSubGrid objects to make active in the solver.  If this parameter is not given, or the list is empty, no subgrids will be active for the given entity, meaning the solver will run over the entire entity.

Returns

This action returns nothing.

$solver run ?-entities ents? ?Initialize | steps?
This action runs the extrusion solver.
$solver project
This action projects the domains in the solver to the databases.
$solver getActiveSubGrids entity
This action gets the active subgrids in the solver for a given entity.
$solver setActiveSubGrids entity ?subgrids?
This action sets the active subgrids in the solver for a given entity.
Base type for all glyph types
The mode base type
The solver mode type
pw::Application begin ?-mode_specific_flags? mode ?entities?
This action begins a mode in the application.
A string is an array of characters.
An integer is a whole number.
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).
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.
A domain sub-grid is a computationally orthogonal, continuous subset of a pw::DomainStructured domain.
A block sub-grid is a computationally orthogonal, continuous subset of a pw::BlockStructured block.
Close