Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
FactorModifier Class Reference

#include <FactorModifier.hpp>

+ Inheritance diagram for FactorModifier:
+ Collaboration diagram for FactorModifier:

Public Member Functions

 FactorModifier (double factor=1)
 
virtual ~FactorModifier ()
 
virtual double Calc (double param, double time)
 
- Public Member Functions inherited from AbstractModifier
 AbstractModifier (void)
 
virtual ~AbstractModifier ()
 

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 

Private Attributes

double mFactor
 

Friends

class boost::serialization::access
 

Detailed Description

This class allows modification of parameters by a scale factor.

Definition at line 49 of file FactorModifier.hpp.

Constructor & Destructor Documentation

◆ FactorModifier()

FactorModifier::FactorModifier ( double  factor = 1)
inline

Constructor

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

Definition at line 75 of file FactorModifier.hpp.

◆ ~FactorModifier()

virtual FactorModifier::~FactorModifier ( )
inlinevirtual

Default destructor.

Definition at line 83 of file FactorModifier.hpp.

Member Function Documentation

◆ Calc()

double FactorModifier::Calc ( double  param,
double  time 
)
virtual

Perform the modification.

Parameters
paramthe current value of the quantity which is being modified
timethe current simulation time
Returns
the new value for the quantity which is being modified

Implements AbstractModifier.

Definition at line 38 of file FactorModifier.cpp.

References mFactor.

◆ serialize()

template<class Archive >
void FactorModifier::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the member variables.

Parameters
archive
version

Definition at line 61 of file FactorModifier.hpp.

References mFactor.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 53 of file FactorModifier.hpp.

Member Data Documentation

◆ mFactor

double FactorModifier::mFactor
private

Factor to multiply parameter of interest by.

Definition at line 68 of file FactorModifier.hpp.

Referenced by Calc(), and serialize().


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