The extrusion solver mode type
pw::Object pw::Mode pw::Solver
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]
pw:: | The extrusion solver mode type |
Instance Attributes | |
KeepFailingStep | This attribute is the flag for whether the failing step of extrusion should be kept. |
Instance Actions | |
run | This action runs the extrusion solver. |
getRunResult | This action gets the result of the last extrusion solver run. |
getStopConditionData | This action gets the stop criteria data of the last run at the given index. |
getInitialResidual | This action gets the initial (requested) residual of the last step run. |
getMaximumResidual | This action gets the maximum residual of the last step run. |
getMinimumJacobian | This action gets the minimum Jacobian of the last step run. |
getMaximumAspectRatio | This action gets the maximum aspect ratio of the last step run. |
getMinimumSkewAngle | This action gets the minimum skew angle of the last step run. |
getStepHeight | This action gets the height of the last step run. |
$solver run ?-entities ents? ?Restart | steps?
This action runs the extrusion solver.
-entities ents | This 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. |
Restart | The optional string mode. Clears all extrusion steps back to the base domain. |
steps | The optional integer number of steps to extrude. Default is 1. |
This action returns nothing.
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.
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
$solver getRunResult
This action gets the result of the last extrusion solver run.
This action has no parameters.
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:
Completed | normal termination |
Error | unknown problem |
InvalidCells | extrusion would produce unsupported cells |
StopCriteria | a grid cell failed the stop criteria |
SolverFailure | internal solver error |
$solver getStopConditionData index
This action gets the stop criteria data of the last run at the given index.
index | This parameter is the cell number; [1, number of cells failing). |
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:
Height | The StopAtHeight value was met or exceeded. |
AspectRatio | The StopAtAspectRatio value was exceeded. |
SkewAngle | The StopAtSkewAngle value was met or exceeded. |
PositiveSkewJacobian | A positive skewed Jacobian was computed. |
ZeroJacobian | A zero Jacobian was computed. |
NegativeSkewJacobian | A negative skewed Jacobian was computed. |
NegativeJacobian | A negative Jacobian was computed. |
$solver getInitialResidual
This action gets the initial (requested) residual of the last step run.
This action has no parameters.
This action returns the float initial residual at the current step.
$solver getMaximumResidual
This action gets the maximum residual of the last step run.
This action has no parameters.
This action returns the float maximum residual at the current step.
$solver getMinimumJacobian
This action gets the minimum Jacobian of the last step run.
This action has no parameters.
This action returns the float minimum Jacobian at the current step.
$solver getMaximumAspectRatio
This action gets the maximum aspect ratio of the last step run.
This action has no parameters.
This action returns the float maximum aspect ratio at the current step.
$solver getMinimumSkewAngle
This action gets the minimum skew angle of the last step run.
This action has no parameters.
This action returns the float minimum skew angle at the current step.
$solver getStepHeight
This action gets the height of the last step run.
This action has no parameters.
This action returns the float height at the current step.
This attribute is the flag for whether the failing step of extrusion should be kept.
$entity get/setKeepFailingStep keep
This action runs the extrusion solver.
$solver run ?-entities ents? ?Restart | steps?
This action gets the result of the last extrusion solver run.
$solver getRunResult
This action gets the stop criteria data of the last run at the given index.
$solver getStopConditionData index
This action gets the initial (requested) residual of the last step run.
$solver getInitialResidual
This action gets the maximum residual of the last step run.
$solver getMaximumResidual
This action gets the minimum Jacobian of the last step run.
$solver getMinimumJacobian
This action gets the maximum aspect ratio of the last step run.
$solver getMaximumAspectRatio
This action gets the minimum skew angle of the last step run.
$solver getMinimumSkewAngle
This action gets the height of the last step run.
$solver getStepHeight
This action begins a mode in the application.
pw::Application begin ?-mode_specific_flags? mode ?entities?