
Public Types | |
| enum | Strategy { uniform, doubling } |
Public Member Functions | |
| TimestepControl (double start=0., double final=1., double tolerance=1.e-2, double start_step=1.e-2, double print_step=-1., double max_step=1.) | |
| void | parse_parameters (ParameterHandler ¶m) |
| double | start () const |
| double | final () const |
| double | tolerance () const |
| double | step () const |
| double | now () const |
| bool | advance () |
| void | start (double) |
| void | final (double) |
| void | tolerance (double) |
| void | strategy (Strategy) |
| void | start_step (double) |
| void | max_step (double) |
| void | restart () |
| bool | print () |
| void | file_name_format (const char *) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler ¶m) |
Private Attributes | |
| double | current_step_val |
Control class for timestepping schemes. Its main task is determining the size of the next time step and the according point in the time interval. Additionally, it controls writing the solution to a file.
The size of the next time step is determined as follows:
The variable print_step can be used to control the amount of output generated by the timestepping scheme.
Definition at line 48 of file timestep_control.h.
The time stepping strategies. These are controlled by the value of tolerance() and start_step().
| uniform |
Choose a uniform time step size. The step size is determined by start_step(), tolerance() is ignored. |
| doubling |
Start with the time step size given by start_step() and double it in every step. tolerance() is ignored. This strategy is intended for pseudo-timestepping schemes computing a stationary limit. |
Definition at line 57 of file timestep_control.h.
| Algorithms::TimestepControl::TimestepControl | ( | double | start = 0., |
| double | final = 1., |
||
| double | tolerance = 1.e-2, |
||
| double | start_step = 1.e-2, |
||
| double | print_step = -1., |
||
| double | max_step = 1. |
||
| ) |
Constructor setting default values
| static void Algorithms::TimestepControl::declare_parameters | ( | ParameterHandler & | param | ) | [static] |
Declare the control parameters for parameter handler.
| void Algorithms::TimestepControl::parse_parameters | ( | ParameterHandler & | param | ) |
Read the control parameters from a parameter handler.
| double Algorithms::TimestepControl::start | ( | ) | const [inline] |
The left end of the time interval.
Definition at line 218 of file timestep_control.h.
| double Algorithms::TimestepControl::final | ( | ) | const [inline] |
The right end of the time interval. The control mechanism ensures that the final time step ends at this point.
Definition at line 225 of file timestep_control.h.
| double Algorithms::TimestepControl::tolerance | ( | ) | const [inline] |
The tolerance value controlling the time steps.
Definition at line 239 of file timestep_control.h.
| double Algorithms::TimestepControl::step | ( | ) | const [inline] |
The size of the current time step.
Definition at line 232 of file timestep_control.h.
References current_step_val.
| double Algorithms::TimestepControl::now | ( | ) | const [inline] |
The current time.
Definition at line 246 of file timestep_control.h.
| bool Algorithms::TimestepControl::advance | ( | ) |
Compute the size of the next step size and return true if it differs from the current step size. Advance the current time by the new step size.
| void Algorithms::TimestepControl::start | ( | double | t | ) | [inline] |
Set start value.
Definition at line 253 of file timestep_control.h.
| void Algorithms::TimestepControl::final | ( | double | t | ) | [inline] |
Set final time value.
Definition at line 260 of file timestep_control.h.
| void Algorithms::TimestepControl::tolerance | ( | double | t | ) | [inline] |
Set tolerance
Definition at line 267 of file timestep_control.h.
| void Algorithms::TimestepControl::strategy | ( | Strategy | t | ) | [inline] |
Set strategy.
Definition at line 274 of file timestep_control.h.
| void Algorithms::TimestepControl::start_step | ( | double | t | ) | [inline] |
Set size of the first step. This may be overwritten by the time stepping strategy.
Definition at line 281 of file timestep_control.h.
| void Algorithms::TimestepControl::max_step | ( | double | t | ) | [inline] |
Set size of the maximum step size.
Definition at line 288 of file timestep_control.h.
| void Algorithms::TimestepControl::restart | ( | ) | [inline] |
Set now() equal to start(). Initialize step() and print() to their initial values.
Definition at line 295 of file timestep_control.h.
References current_step_val.
| bool Algorithms::TimestepControl::print | ( | ) |
Return true if this timestep should be written to disk.
| void Algorithms::TimestepControl::file_name_format | ( | const char * | fmt | ) | [inline] |
Set the output name template.
Definition at line 308 of file timestep_control.h.
double Algorithms::TimestepControl::current_step_val [private] |
The size of the current time step. This may differ from step_val, if we aimed at final_val.
Definition at line 206 of file timestep_control.h.
documentation generated on Thu May 17 2012 20:05:32 by
doxygen
1.7.3