pw::ExtrusionSolver

The extrusion 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 ExtrusionSolver specified, like this:

set solver [pw::Application begin ExtrusionSolver $entities]
Summary
pw::ExtrusionSolverThe extrusion solver mode type
Instance Attributes
KeepFailingStepThis attribute is the flag for whether the failing step of extrusion should be kept.
Instance Actions
runThis action runs the extrusion solver.
getRunResultThis action gets the result of the last extrusion solver run.
getStopConditionDataThis action gets the stop criteria data of the last run at the given index.
getInitialResidualThis action gets the initial (requested) residual of the last step run.
getMaximumResidualThis action gets the maximum residual of the last step run.
getMinimumJacobianThis action gets the minimum Jacobian of the last step run.
getMaximumAspectRatioThis action gets the maximum aspect ratio of the last step run.
getMinimumSkewAngleThis action gets the minimum skew angle of the last step run.
getStepHeightThis action gets the height of the last step run.

Instance Attributes

KeepFailingStep

$entity get/setKeepFailingStep keep

This attribute is the flag for whether the failing step of extrusion should be kept.

Type

boolean

Default

false

Instance Actions

run

$solver run ?-entities ents? ?Restart | 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.
RestartThe optional string mode.  Clears all extrusion steps back to the base domain.
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           ;# extrude 1 step
$solver run 5         ;# extrude 5 steps
$solver run Restart   ;# clear all extrusion steps
$solver run Restart 9 ;# INVALID

See also pw.Solver

getRunResult

$solver getRunResult

This action gets the result of the last extrusion solver run.

Parameters

This action has no parameters.

Returns

This action returns a list of solver status and the number of cells failing the stop crieteria.  Solver status is one of the following strings:

Completednormal termination
Errorunknown problem
InvalidCellsextrusion would produce unsupported cells
StopCriteriaa grid cell failed the stop criteria
SolverFailureinternal solver error

getStopConditionData

$solver getStopConditionData index

This action gets the stop criteria data of the last run at the given index.

Parameters

indexThis parameter is the cell number; [1, number of cells failing).

Returns

This action returns a list of results containing the name of entity containing criteria failure, the IJK index or prism cell number of criteria failure, the type of failure, the cell criteria value, and a list of cell vertex coordinates.  The failure type is one of the following strings:

HeightThe StopAtHeight value was met or exceeded.
AspectRatioThe StopAtAspectRatio value was exceeded.
SkewAngleThe StopAtSkewAngle value was met or exceeded.
PositiveSkewJacobianA positive skewed Jacobian was computed.
ZeroJacobianA zero Jacobian was computed.
NegativeSkewJacobianA negative skewed Jacobian was computed.
NegativeJacobianA negative Jacobian was computed.

getInitialResidual

$solver getInitialResidual

This action gets the initial (requested) residual of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float initial residual at the current step.

getMaximumResidual

$solver getMaximumResidual

This action gets the maximum residual of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float maximum residual at the current step.

getMinimumJacobian

$solver getMinimumJacobian

This action gets the minimum Jacobian of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float minimum Jacobian at the current step.

getMaximumAspectRatio

$solver getMaximumAspectRatio

This action gets the maximum aspect ratio of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float maximum aspect ratio at the current step.

getMinimumSkewAngle

$solver getMinimumSkewAngle

This action gets the minimum skew angle of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float minimum skew angle at the current step.

getStepHeight

$solver getStepHeight

This action gets the height of the last step run.

Parameters

This action has no parameters.

Returns

This action returns the float height at the current step.

$entity get/setKeepFailingStep keep
This attribute is the flag for whether the failing step of extrusion should be kept.
$solver run ?-entities ents? ?Restart | steps?
This action runs the extrusion solver.
$solver getRunResult
This action gets the result of the last extrusion solver run.
$solver getStopConditionData index
This action gets the stop criteria data of the last run at the given index.
$solver getInitialResidual
This action gets the initial (requested) residual of the last step run.
$solver getMaximumResidual
This action gets the maximum residual of the last step run.
$solver getMinimumJacobian
This action gets the minimum Jacobian of the last step run.
$solver getMaximumAspectRatio
This action gets the maximum aspect ratio of the last step run.
$solver getMinimumSkewAngle
This action gets the minimum skew angle of the last step run.
$solver getStepHeight
This action gets the height of the last step run.
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 boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A string is an array of characters.
An integer is a whole number.
A float is a fractional number.
Close