TimeModifier Class Reference

#include <Modifiers.hpp>

Inheritance diagram for TimeModifier:

Inheritance graph
[legend]
Collaboration diagram for TimeModifier:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TimeModifier ()
virtual double Calc (double param, double time)


Detailed Description

This is just an example class to show how you might specify a custom modifier to change a parameter through time. In this case it implements a sin(time)*default_parameter factor modifier.

Definition at line 71 of file Modifiers.hpp.


Constructor & Destructor Documentation

TimeModifier::TimeModifier (  )  [inline]

Constructor

Definition at line 77 of file Modifiers.hpp.


Member Function Documentation

virtual double TimeModifier::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

Implements AbstractModifier.

Definition at line 87 of file Modifiers.hpp.


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

Generated on Mon Nov 1 12:37:27 2010 for Chaste by  doxygen 1.5.5