Chaste  Release::2018.1
DummyModifier Class Reference

#include <DummyModifier.hpp>

+ Inheritance diagram for DummyModifier:
+ Collaboration diagram for DummyModifier:

Public Member Functions

 DummyModifier ()
 
virtual ~DummyModifier ()
 
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)
 

Friends

class boost::serialization::access
 

Detailed Description

This class returns the parameter's default value and does not modify it.

Definition at line 49 of file DummyModifier.hpp.

Constructor & Destructor Documentation

DummyModifier::DummyModifier ( )
inline

Default constructor

Definition at line 71 of file DummyModifier.hpp.

virtual DummyModifier::~DummyModifier ( )
inlinevirtual

Default destructor.

Definition at line 78 of file DummyModifier.hpp.

Member Function Documentation

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

This calculate does nothing and returns the parameter 'unharmed'.

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 DummyModifier.cpp.

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

Archive the member variables.

Parameters
archive
version

Definition at line 61 of file DummyModifier.hpp.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 53 of file DummyModifier.hpp.


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