Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

dolfin::Regulator Class Reference

Time step regulator. More...

#include <Regulator.h>

List of all members.

Public Member Functions

 Regulator ()
 Constructor.

 Regulator (real k)
 Constructor.

 ~Regulator ()
 Destructor.

void init (real k)
 Initialize regulator (specify first time step).

void update (real k, real kmax, bool kfixed)
 Update time step (set new desired value).

void update (real kmax)
 Update maximum time step.

real timestep () const
 Return time step.


Detailed Description

Time step regulator.


Constructor & Destructor Documentation

Regulator::Regulator (   ) 
 

Constructor.

Regulator::Regulator (  real  k  ) 
 

Constructor.

Regulator::~Regulator (   ) 
 

Destructor.


Member Function Documentation

void Regulator::init (  real  k  ) 
 

Initialize regulator (specify first time step).

real Regulator::timestep (   )  const
 

Return time step.

void Regulator::update (  real  kmax  ) 
 

Update maximum time step.

void Regulator::update (  real  k,
real  kmax,
bool  kfixed
) 
 

Update time step (set new desired value).


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


Documentation automatically generated with Doxygen on 10 Sep 2004.