FiniteDifferenceStep¶
-
class
FiniteDifferenceStep
(*args)¶ Base class to define finite difference steps.
- Available constructors:
FiniteDifferenceStep(epsilon=[1.0])
- Parameters
- epsilonsequence of float
Finite difference steps for each dimension.
Notes
Base class to define how finite difference steps are computed. Using FiniteDifferenceStep is equivalent to use its derived class
ConstantStep
. Another way to compute steps is through its second derived classBlendedStep
.Methods
__call__
(self, inP)Call self as a function.
getClassName
(self)Accessor to the object’s name.
getEpsilon
(self)Get the finite difference steps.
getId
(self)Accessor to the object’s id.
getImplementation
(self, \*args)Accessor to the underlying implementation.
getName
(self)Accessor to the object’s name.
setEpsilon
(self, epsilon)Set the finite difference steps.
setName
(self, name)Accessor to the object’s name.
-
__init__
(self, *args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName
(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getEpsilon
(self)¶ Get the finite difference steps.
- Returns
- epsilon
Point
If
ConstantStep
: Finite difference steps for each dimension.If
BlendedStep
: Finite difference step factors for each dimension.
- epsilon
-
getId
(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getImplementation
(self, *args)¶ Accessor to the underlying implementation.
- Returns
- implImplementation
The implementation class.
-
getName
(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
setEpsilon
(self, epsilon)¶ Set the finite difference steps.
- Parameters
- epsilonsequence of float
If
ConstantStep
: Finite difference steps for each dimension.If
BlendedStep
: Finite difference step factors for each dimension.
-
setName
(self, name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.