![]() |
Reference documentation for deal.II version 8.1.0
|
#include <timestep_control.h>
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 *) |
const char * | file_name_format () |
![]() | |
Subscriptor () | |
Subscriptor (const Subscriptor &) | |
virtual | ~Subscriptor () |
Subscriptor & | operator= (const Subscriptor &) |
void | subscribe (const char *identifier=0) const |
void | unsubscribe (const char *identifier=0) const |
unsigned int | n_subscriptions () const |
void | list_subscribers () const |
DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.") | |
DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1) | |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Static Public Member Functions | |
static void | declare_parameters (ParameterHandler ¶m) |
Private Attributes | |
double | start_val |
double | final_val |
double | tolerance_val |
Strategy | strategy_val |
double | start_step_val |
double | max_step_val |
double | min_step_val |
double | current_step_val |
double | step_val |
double | now_val |
double | print_step |
double | next_print_val |
char | format [30] |
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 53 of file timestep_control.h.
The time stepping strategies. These are controlled by the value of tolerance() and start_step().
Enumerator | |
---|---|
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 62 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 |
Declare the control parameters for parameter handler.
void Algorithms::TimestepControl::parse_parameters | ( | ParameterHandler & | param | ) |
Read the control parameters from a parameter handler.
|
inline |
The left end of the time interval.
Definition at line 223 of file timestep_control.h.
|
inline |
The right end of the time interval. The control mechanism ensures that the final time step ends at this point.
Definition at line 230 of file timestep_control.h.
|
inline |
The tolerance value controlling the time steps.
Definition at line 244 of file timestep_control.h.
|
inline |
The size of the current time step.
Definition at line 237 of file timestep_control.h.
|
inline |
The current time.
Definition at line 251 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.
|
inline |
Set start value.
Definition at line 258 of file timestep_control.h.
|
inline |
Set final time value.
Definition at line 265 of file timestep_control.h.
|
inline |
Set tolerance
Definition at line 272 of file timestep_control.h.
|
inline |
Set strategy.
Definition at line 279 of file timestep_control.h.
|
inline |
Set size of the first step. This may be overwritten by the time stepping strategy.
Definition at line 286 of file timestep_control.h.
|
inline |
Set size of the maximum step size.
Definition at line 293 of file timestep_control.h.
|
inline |
bool Algorithms::TimestepControl::print | ( | ) |
Return true if this timestep should be written to disk.
|
inline |
Set the output name template.
Definition at line 313 of file timestep_control.h.
|
private |
The size of the current time step. This may differ from step_val
, if we aimed at final_val
.
Definition at line 211 of file timestep_control.h.