2.0.0b10
catchment modelling framework
Loading...
Searching...
No Matches
StateVariable Class Referenceabstract

Abstract class state variable. More...

+ Inheritance diagram for StateVariable:

Detailed Description

Abstract class state variable.

   Simple exponential system class header implementing a state variable:
   @code
   class RateGrowth
   {
   public:
       real rate;
       virtual real Derivate(const cmf::math::Time& time) {return rate*get_state();}
   };
   @endcode

Public Member Functions

 StateVariable (real InitialState=0, real scale=1)
 ctor
 
virtual real dxdt (const cmf::math::Time &time)=0
 Returns the derivate of the state variable at time time.
 
real get_state () const
 Returns the current state of the variable.
 
void set_state (real newState)
 Gives access to the state variable.
 

Protected Member Functions

void MarkStateChangeHandled ()
 Sets the updated flag (m_StateIsNew) to false.
 
bool StateIsChanged ()
 Returns if the state was currently updated.