RootStrategy¶

class
RootStrategy
(*args)¶ Base class for root strategies.
RootStrategy is used through its derived classes:
See also
Methods
getClassName
()Accessor to the object’s name. getId
()Accessor to the object’s id. getImplementation
(*args)Accessor to the underlying implementation. getMaximumDistance
()Get the maximum distance. getName
()Accessor to the object’s name. getOriginValue
()Get the origin value. getSolver
()Get the solver. getStepSize
()Get the step size. setMaximumDistance
(maximumDistance)Set the maximum distance. setName
(name)Accessor to the object’s name. setOriginValue
(originValue)Set the origin value. setSolver
(solver)Set the solver. setStepSize
(stepSize)Set the step size. solve
(function, value)Give all the roots found applying the root strategy. 
__init__
(*args)¶

getClassName
()¶ Accessor to the object’s name.
Returns: class_name : str
The object class name (object.__class__.__name__).

getId
()¶ Accessor to the object’s id.
Returns: id : int
Internal unique identifier.

getImplementation
(*args)¶ Accessor to the underlying implementation.
Returns: impl : Implementation
The implementation class.

getMaximumDistance
()¶ Get the maximum distance.
Returns: maximumDistance : positive float
Distance from the center of the standard space until which we research an intersection with the limit state function along each direction. By default, the maximum distance is equal to the value defined through the key RootStrategyImplementationDefaultMaximumDistance of the
ResourceMap
.

getName
()¶ Accessor to the object’s name.
Returns: name : str
The name of the object.

getOriginValue
()¶ Get the origin value.
Returns: origin : float
Value of the limit state function at the center of the standard space.

getSolver
()¶ Get the solver.
Returns: solver :
Solver
Non linear solver which will research the root in a segment.

getStepSize
()¶ Get the step size.
Returns: stepSize : float
Length of each segment inside which the root research is performed. By default, the step size is equal to the value defined through the key RootStrategyImplementationDefaultStepSize of the
ResourceMap
.

setMaximumDistance
(maximumDistance)¶ Set the maximum distance.
Parameters: maximumDistance : positive float
Distance from the center of the standard space until which we research an intersection with the limit state function along each direction. By default, the maximum distance is equal to the value defined through the key RootStrategyImplementationDefaultMaximumDistance of the
ResourceMap
.

setName
(name)¶ Accessor to the object’s name.
Parameters: name : str
The name of the object.

setOriginValue
(originValue)¶ Set the origin value.
Parameters: origin : float
Value of the limit state function at the center of the standard space.

setSolver
(solver)¶ Set the solver.
Parameters: solver :
Solver
Non linear solver which will research the root in a segment.

setStepSize
(stepSize)¶ Set the step size.
Parameters: stepSize : float
Length of each segment inside which the root research is performed. By default, the step size is equal to the value defined through the key RootStrategyImplementationDefaultStepSize of the
ResourceMap
.

solve
(function, value)¶ Give all the roots found applying the root strategy.
Parameters: function :
NumericalMathFunction
Function from to along the ray, a linear function along the direction.
value : float
Returns: roots :
NumericalScalarCollection
All the roots found applying the root strategy.
 If
SafeAndSlow
: all the real values such as function(x) = value researched in each segment of length stepSize, within [origin, maximumDistance].  If
RiskyAndFast
: the real value such as function(x) = value researched within [origin, maximumDistance].  If
MediumSafe
: the real value such as function(x) = value researched the first segment of length stepSize, within [origin, maximumDistance] where a sign changement of function has been detected.
 If
