From b524c8bad29e9ef8e6d9de68aa6c3d88daa17d12 Mon Sep 17 00:00:00 2001 From: Wenqing Wang <wenqing.wang@ufz.de> Date: Tue, 2 May 2017 13:55:45 +0200 Subject: [PATCH] [dt] Added the parameter documentation for time steppers --- Documentation/ProjectFile/prj/time_loop/i_time_loop.md | 2 +- .../EvolutionaryPIDcontroller/c_EvolutionaryPIDcontroller.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_dt_guess.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_dt_max.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_dt_min.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_norm_type.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_rel_dt_max.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_rel_dt_min.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_specific_times.md | 2 ++ .../time_stepping/EvolutionaryPIDcontroller/t_t_end.md | 1 + .../time_stepping/EvolutionaryPIDcontroller/t_t_initial.md | 1 + .../time_loop/time_stepping/EvolutionaryPIDcontroller/t_tol.md | 1 + .../time_stepping/FixedTimeStepping/c_FixedTimeStepping.md | 2 +- .../prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md | 2 +- .../time_loop/time_stepping/FixedTimeStepping/t_t_initial.md | 2 +- .../prj/time_loop/time_stepping/SingleStep/c_SingleStep.md | 2 +- .../ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md | 2 +- Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md | 2 +- 18 files changed, 19 insertions(+), 7 deletions(-) create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/c_EvolutionaryPIDcontroller.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_guess.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_max.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_min.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_norm_type.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_max.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_min.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_specific_times.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_end.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_initial.md create mode 100644 Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_tol.md diff --git a/Documentation/ProjectFile/prj/time_loop/i_time_loop.md b/Documentation/ProjectFile/prj/time_loop/i_time_loop.md index 576add64edc..aa3cece571f 100644 --- a/Documentation/ProjectFile/prj/time_loop/i_time_loop.md +++ b/Documentation/ProjectFile/prj/time_loop/i_time_loop.md @@ -1 +1 @@ -\ogs_missing_documentation +Time discretization loop. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/c_EvolutionaryPIDcontroller.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/c_EvolutionaryPIDcontroller.md new file mode 100644 index 00000000000..730f3fe09a1 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/c_EvolutionaryPIDcontroller.md @@ -0,0 +1 @@ +\copydoc NumLib::EvolutionaryPIDcontroller diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_guess.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_guess.md new file mode 100644 index 00000000000..96fc64a7031 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_guess.md @@ -0,0 +1 @@ +The initial guess of time step size. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_max.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_max.md new file mode 100644 index 00000000000..da4f14e9332 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_max.md @@ -0,0 +1 @@ +The maximum restriction of time step size. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_min.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_min.md new file mode 100644 index 00000000000..c975b5939b8 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_dt_min.md @@ -0,0 +1 @@ +The minimum restriction of time step size. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_norm_type.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_norm_type.md new file mode 100644 index 00000000000..de46a911c18 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_norm_type.md @@ -0,0 +1 @@ +The norm type of the global vector for error calculation. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_max.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_max.md new file mode 100644 index 00000000000..b83f827b1b9 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_max.md @@ -0,0 +1 @@ +The maximum restriction of time step size ratio against the previous time step. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_min.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_min.md new file mode 100644 index 00000000000..5d846abd2b5 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_rel_dt_min.md @@ -0,0 +1 @@ +The minimum restriction of time step size ratio against the previous time step. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_specific_times.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_specific_times.md new file mode 100644 index 00000000000..92fff5fadbd --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_specific_times.md @@ -0,0 +1,2 @@ +The specified times that must be reached in the time stepping. + diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_end.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_end.md new file mode 100644 index 00000000000..ce96f332203 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_end.md @@ -0,0 +1 @@ +The end time. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_initial.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_initial.md new file mode 100644 index 00000000000..7ca53cb25af --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_t_initial.md @@ -0,0 +1 @@ +The begin time. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_tol.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_tol.md new file mode 100644 index 00000000000..804855455c2 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/EvolutionaryPIDcontroller/t_tol.md @@ -0,0 +1 @@ +The tolerance of the relative error that controls the time stepping. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md index 576add64edc..6c73dd28077 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a fixed time step method. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md index 576add64edc..ce96f332203 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md @@ -1 +1 @@ -\ogs_missing_documentation +The end time. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md index 576add64edc..7ca53cb25af 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md @@ -1 +1 @@ -\ogs_missing_documentation +The begin time. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md index 576add64edc..116071e10a2 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a SingleStep time stepper. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md index 576add64edc..3e5fafed095 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a time stepper. diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md index 576add64edc..2cac2c7c0de 100644 --- a/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md @@ -1 +1 @@ -\ogs_missing_documentation +The type of a time stepping method. -- GitLab