diff --git a/Documentation/ProjectFile/prj/time_loop/i_time_loop.md b/Documentation/ProjectFile/prj/time_loop/i_time_loop.md index 576add64edccf5d980a0ff86143dc43a7109a788..aa3cece571f10e2567a06028b73a3626306799d2 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 0000000000000000000000000000000000000000..730f3fe09a1c9d2661ad05c7eefea7edf7e2d72d --- /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 0000000000000000000000000000000000000000..96fc64a7031a9a2b48ad4b8860842cdf3b216418 --- /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 0000000000000000000000000000000000000000..da4f14e93324fe19019153f66e3cf7926175e4f3 --- /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 0000000000000000000000000000000000000000..c975b5939b85682055c0d50049ff03b2a74ade5a --- /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 0000000000000000000000000000000000000000..de46a911c18183e2aa51bd519b3a5bfe54c72d67 --- /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 0000000000000000000000000000000000000000..b83f827b1b9a03f6a3fe474d03e904c3202ac72a --- /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 0000000000000000000000000000000000000000..5d846abd2b589b661dfa5d19d20fd3b3ce40767b --- /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 0000000000000000000000000000000000000000..92fff5fadbdc54f4f17ebfe9d85beb72be5ee700 --- /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 0000000000000000000000000000000000000000..ce96f332203a067242130456016be3ff2455f3d4 --- /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 0000000000000000000000000000000000000000..7ca53cb25af157b6f0b483ed4128adac11267fc8 --- /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 0000000000000000000000000000000000000000..804855455c24028e0b0f842e004cd0b71583e33d --- /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 576add64edccf5d980a0ff86143dc43a7109a788..6c73dd28077ea87e2a77268299c7d816776654b0 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 576add64edccf5d980a0ff86143dc43a7109a788..ce96f332203a067242130456016be3ff2455f3d4 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 576add64edccf5d980a0ff86143dc43a7109a788..7ca53cb25af157b6f0b483ed4128adac11267fc8 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 576add64edccf5d980a0ff86143dc43a7109a788..116071e10a23f299e7fa086986f3eac260d1c677 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 576add64edccf5d980a0ff86143dc43a7109a788..3e5fafed0952b5cc42ed90619f990818ab02883a 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 576add64edccf5d980a0ff86143dc43a7109a788..2cac2c7c0deff1b4f42f6fa915daca19e8c51d31 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.