The solver mode type
pw:: | The solver mode type |
Instance Actions | |
run | This action runs the solver. |
resume | This action resumes running the solver. |
getCompletedSteps | This action returns the number of steps completed by the last call to run or resume. |
getCompletedEntities | This action returns the list of entities completed by the last call to run or resume. |
getFailedEntities | This action returns the list of entities failed by the last call to run or resume. |
$solver run ?-entities ents? ?steps | method ?method_args??
This action runs the solver.
-entities ents | This optional parameter is a subset of the entities in the solver mode to run the solver on. If this parameter is not given the solver will be run on all the entities of the solver mode. |
steps | This optional parameter is the integer number of steps to run; The default is set by each solver (usually 1). The solver will run until steps is reached, a stop is requested by the user, or some other stop condition is encountered. This parameter is only valid for the pw.ExtrusionSolver, the pw.HighOrderSolver, and for the Smooth method of the pw.UnstructuredSolver for blocks. |
method | The optional method to run: Initialize | Refine | Decimate | Release | Smooth | Restart | PushAttributes | BoundaryAdaptation. Not all methods are valid for all solver modes. See solver-specific run docs for details. |
method_args | Additional method-specific arguments. See solver-specific run docs for details. |
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.
See pw.EllipticSolver, pw.ExtrusionSolver, pw.HighOrderSolver, pw.ReExtrusionSolver, pw.UnstructuredSolver, pw.VoxelSolver.
$solver resume
This action resumes running the solver. It does nothing if the solver has not been run yet, or if the previous run has completed.
This action has no parameters.
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.
$solver getCompletedSteps
This action returns the number of steps completed by the last call to run or resume.
This action has no parameters.
This action returns the integer number of steps completed.
The number of completed steps will only be valid when the previous solver run used the steps parameter.
When steps are run on structured blocks, the value returned is for all blocks processed.
When steps are run on unstructured or iso voxel blocks, the value returned is only for the last block processed.
$solver getCompletedEntities
This action returns the list of entities completed by the last call to run or resume.
This action has no parameters.
This action returns a list of pw::Entity objects that have been completed.
The list of completed entities will only be populated if the previous solver run used the method parameter.
$solver getFailedEntities
This action returns the list of entities failed by the last call to run or resume.
This action has no parameters.
This action returns a list of pw::Entity objects that failed.
The list of failed entities will only be populated if the previous solver run used the method parameter.
This action runs the solver.
$solver run ?-entities ents? ?steps | method ?method_args??
This action resumes running the solver.
$solver resume
This action returns the number of steps completed by the last call to run or resume.
$solver getCompletedSteps
This action returns the list of entities completed by the last call to run or resume.
$solver getCompletedEntities
This action returns the list of entities failed by the last call to run or resume.
$solver getFailedEntities