Inheritance diagram for FactorModifier:

Collaboration diagram for FactorModifier:

Public Member Functions
	FactorModifier (double factor=1)
virtual double	Calc (double param, double time)
Private Attributes
double	mFactor

Detailed Description

This class allows modification of parameters by a scale factor.

Definition at line 45 of file Modifiers.hpp.

Constructor & Destructor Documentation

FactorModifier::FactorModifier ( double factor = 1 ) [inline]

Constructor

Parameters:

factor scale factor to use, defaults to 1 (i.e. no effect)

Definition at line 56 of file Modifiers.hpp.

virtual double FactorModifier::Calc	(	double	param,
		double	time
	)		`[inline, virtual]`

Perform the modification.

Parameters:

param	the current value of the quantity which is being modified
time	the current simulation time

Definition at line 67 of file Modifiers.hpp.

References mFactor.

Factor to multiply parameter of interest by.

Definition at line 49 of file Modifiers.hpp.

Referenced by Calc().

The documentation for this class was generated from the following file: