Class StepLengthModifier
Defined in File Acceleration.h
Inheritance Relationships
Base Type
public Referenced
(Class Referenced)
Derived Type
public DirectedFlowOfScatterCenters
(Class DirectedFlowOfScatterCenters)
Class Documentation
-
class StepLengthModifier : public Referenced
Modifies the steplength of an acceleration module.
Subclassed by DirectedFlowOfScatterCenters
Public Functions
-
virtual double modify(double steplength, Candidate *candidate) = 0
Returns an update of the steplength.
- Parameters:
steplength – Modifies step length, e.g., based on scattering model.
candidate – Additional candidate properties are usually included in the calculation of the updated step length.
-
inline size_t addReference() const
-
inline size_t removeReference() const
-
inline int removeReferenceNoDelete() const
-
inline size_t getReferenceCount() const
Protected Attributes
-
mutable size_t _referenceCount
-
virtual double modify(double steplength, Candidate *candidate) = 0