def predictor_typeendgame_get():
r"""
Returns an integer which represents the type of the predictor
along a path, before the start of the end game.
The integer on return takes values between 0 and 9, depending on
the type for the solution x and for the continuation parameter t.
The ten predictor types are
0 : secant for x, real for t;
1 : secant for x, complex for t;
2 : secant for x, geometric for t;
3 : tangent for x, real for t;
4 : tangent for x, complex for t;
5 : tangent for x, geometric for t;
6 : Hermite for x, real for t;
7 : quadratic for x, real for t;
8 : cubic for x, real for t;
9 : quartic for x, real for t.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(8))
def tolerance_infsolendgame_get():
"""
Returns the tolerance threshold to decide whether a solution path
diverges to infinity, during the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(34)
def corrector_abscoronpath_get():
"""
Returns the value of the tolerance on the absolute correction for
the corrector along a path, before the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(27))
def corrector_abscorendgame_get():
"""
Returns the value of the tolerance on the absolute correction for
the corrector during the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(28))
def corrector_relresendgame_get():
"""
Returns the value of the tolerance on the relative residual for
the corrector during the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(22))
def corrector_abscoronpath_get():
"""
Returns the value of the tolerance on the absolute correction for
the corrector along a path, before the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(27))
def predictor_typeendgame_get():
r"""
Returns an integer which represents the type of the predictor
along a path, before the start of the end game.
The integer on return takes values between 0 and 9, depending on
the type for the solution x and for the continuation parameter t.
The ten predictor types are
0 : secant for x, real for t;
1 : secant for x, complex for t;
2 : secant for x, geometric for t;
3 : tangent for x, real for t;
4 : tangent for x, complex for t;
5 : tangent for x, geometric for t;
6 : Hermite for x, real for t;
7 : quadratic for x, real for t;
8 : cubic for x, real for t;
9 : quartic for x, real for t.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(8))
def corrector_relresonpath_get():
"""
Returns the value of the tolerance on the relative residual for
the corrector along a path, before the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(21))
def corrector_maxiterendgame_get():
"""
Returns the maximum number of iterations the corrector does along
a path, during the end game. The default equals 3.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(20))
def corrector_maxiterendgame_get():
"""
Returns the maximum number of iterations the corrector does along
a path, during the end game. The default equals 3.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(20))
def corrector_relresonpath_get():
"""
Returns the value of the tolerance on the relative residual for
the corrector along a path, before the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(21))
def corrector_relresendgame_get():
"""
Returns the value of the tolerance on the relative residual for
the corrector during the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(22))
def tolerance_clustsolendgame_get():
"""
Returns the tolerance on the distance between two solutions to decide
whether two solutions are clustered during the end game.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(32)
def tolerance_rcondendgame_get():
"""
Returns the tolerance on the inverse condition number of the Jacobian
matrix of a solution, during the end game, to decide whether a solution
is singular or not.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(30)
def tolerance_rcondonpath_get():
"""
Returns the tolerance on the inverse condition number of the Jacobian
matrix of a solution along a path, before the end game, to decide
whether a solution is singular.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(29)
def predictor_maxstependgame_get():
"""
Returns the maximum value of the step size during the end game.
The step size control will never increase the step size to a value
above this maximum.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(12)
def max_steps_get():
"""
Returns the maximum number of steps the path tracker will perform
to reach the end of a solution path. For paths that diverge to
infinity are often truncated beore reaching extreme values.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(3))
def order_endgame_extrapolator_get():
"""
Returns the order of the extrapolator to estimate the winding number
in a polyhedral end game.
If the order is zero, then no polyhedral end game will be applied.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(5))
def predictor_maxstependgame_get():
"""
Returns the maximum value of the step size during the end game.
The step size control will never increase the step size to a value
above this maximum.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(12)
def predictor_minstependgame_get():
"""
Returns the minimum value of the step size during the end game.
If the step size control cuts the step size to a value
below this minimum, then the path tracking is aborted.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(10)
def condition_level_get():
"""
Returns an integer that represents the difficulty level
of the homotopy. The default level equals zero,
higher values lead to smaller tolerances.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(1))
def predictor_minstependgame_get():
"""
Returns the minimum value of the step size during the end game.
If the step size control cuts the step size to a value
below this minimum, then the path tracking is aborted.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(10)
def condition_level_get():
"""
Returns an integer that represents the difficulty level
of the homotopy. The default level equals zero,
higher values lead to smaller tolerances.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(1))
def order_endgame_extrapolator_get():
"""
Returns the order of the extrapolator to estimate the winding number
in a polyhedral end game.
If the order is zero, then no polyhedral end game will be applied.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(5))
def maxnum_reruns_get():
"""
Returns the value of the maximum number of path reruns.
If path jumping is detected, then the clustered paths are retracked
with more severe values of the tolerances.
The default value equals one.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(6))
def predictor_redfacendgame_get():
"""
Returns the value of the reduction factor to cut the step size in case
of a failed corrector stage, during the end game.
The reduction factor determines the speed at which the predictor reduces
its step size when tracking a more difficult portion of the path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(14)
def predictor_expfacendgame_get():
"""
Returns the value of the expansion factor to increase the step size in
case of a successful corrector stage, during the end game.
The expansion factor determines the speed at which the predictor increases
its step size when tracking an easier portion of the path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(16)
def predictor_exptrsendgame_get():
"""
Returns the value of the expansion threshold for the step size control,
during the end game.
The expansion threshold is the number of consecutive successful
corrector stages that must be met before the step size is increased.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(18))
def predictor_exptrsendgame_get():
"""
Returns the value of the expansion threshold for the step size control,
during the end game.
The expansion threshold is the number of consecutive successful
corrector stages that must be met before the step size is increased.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(18))
def predictor_expfacendgame_get():
"""
Returns the value of the expansion factor to increase the step size in
case of a successful corrector stage, during the end game.
The expansion factor determines the speed at which the predictor increases
its step size when tracking an easier portion of the path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(16)
def predictor_redfacendgame_get():
"""
Returns the value of the reduction factor to cut the step size in case
of a failed corrector stage, during the end game.
The reduction factor determines the speed at which the predictor reduces
its step size when tracking a more difficult portion of the path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(14)
def maxnum_reruns_get():
"""
Returns the value of the maximum number of path reruns.
If path jumping is detected, then the clustered paths are retracked
with more severe values of the tolerances.
The default value equals one.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(6))
def distance_to_endgame_get():
"""
Returns the distance to start the end game. During the end game,
the path tracker may apply tolerances that are more severe as the
solution paths get more interesting near the end.
The default value is 0.1.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(4)
def distance_to_endgame_get():
"""
Returns the distance to start the end game. During the end game,
the path tracker may apply tolerances that are more severe as the
solution paths get more interesting near the end.
The default value is 0.1.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return get(4)
def track_simultaneously_get():
"""
Returns the number of paths that are tracked simultaneously, for the
same discretization of the interval of the continuation parameter.
The default value equals one. Increasing this value avoids path crossing,
also called path jumping. This jumping happens when the approximated
points on one path transition to approximated points on another path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(2))
def track_simultaneously_get():
"""
Returns the number of paths that are tracked simultaneously, for the
same discretization of the interval of the continuation parameter.
The default value equals one. Increasing this value avoids path crossing,
also called path jumping. This jumping happens when the approximated
points on one path transition to approximated points on another path.
"""
from phcpy.phcpy2c2 import py2c_get_value_of_continuation_parameter as get
return int(get(2))