From d3143a31c9014ebd72fb33e822f6f57f00e32907 Mon Sep 17 00:00:00 2001 From: joergbuchwald <44933043+joergbuchwald@users.noreply.github.com> Date: Thu, 21 Mar 2019 14:44:53 +0100 Subject: [PATCH] updating some documentationg pages (#2435) --- Documentation/ProjectFile/prj/mesh/i_mesh.md | 2 +- .../ProjectFile/prj/parameters/parameter/t_type.md | 3 ++- Documentation/ProjectFile/prj/processes/process/t_type.md | 2 +- Documentation/ProjectFile/prj/t_geometry.md | 6 +++++- .../ProjectFile/prj/time_loop/processes/process/a_ref.md | 3 ++- .../prj/time_loop/processes/process/i_process.md | 2 +- .../prj/time_loop/processes/process/t_nonlinear_solver.md | 2 +- .../processes/process/time_discretization/t_type.md | 2 +- .../FixedTimeStepping/timesteps/i_timesteps.md | 6 +++++- .../FixedTimeStepping/timesteps/pair/i_pair.md | 2 +- .../FixedTimeStepping/timesteps/pair/t_delta_t.md | 2 +- .../FixedTimeStepping/timesteps/pair/t_repeat.md | 2 +- .../prj/time_loop/processes/process/time_stepping/t_type.md | 3 ++- 13 files changed, 24 insertions(+), 13 deletions(-) diff --git a/Documentation/ProjectFile/prj/mesh/i_mesh.md b/Documentation/ProjectFile/prj/mesh/i_mesh.md index 11ed78b9ec0..a5c1b7bd72c 100644 --- a/Documentation/ProjectFile/prj/mesh/i_mesh.md +++ b/Documentation/ProjectFile/prj/mesh/i_mesh.md @@ -1 +1 @@ -Information about input mesh. +Path to the `.vtu` (VTK unstructured grid) file to specify the finite element mesh. \ No newline at end of file diff --git a/Documentation/ProjectFile/prj/parameters/parameter/t_type.md b/Documentation/ProjectFile/prj/parameters/parameter/t_type.md index 8ef568698c3..2d7a904f598 100644 --- a/Documentation/ProjectFile/prj/parameters/parameter/t_type.md +++ b/Documentation/ProjectFile/prj/parameters/parameter/t_type.md @@ -1 +1,2 @@ -Sets the parameter type. +Sets the parameter type. Possible values are given in \ref ogs_file_param__prj__parameters__parameter. + diff --git a/Documentation/ProjectFile/prj/processes/process/t_type.md b/Documentation/ProjectFile/prj/processes/process/t_type.md index 576add64edc..454647b9f0b 100644 --- a/Documentation/ProjectFile/prj/processes/process/t_type.md +++ b/Documentation/ProjectFile/prj/processes/process/t_type.md @@ -1 +1 @@ -\ogs_missing_documentation +Specifies the process type. See \ref ogs_file_param__prj__processes__process cases for possible parameters. diff --git a/Documentation/ProjectFile/prj/t_geometry.md b/Documentation/ProjectFile/prj/t_geometry.md index f1ddc3cf01b..6b92265a29f 100644 --- a/Documentation/ProjectFile/prj/t_geometry.md +++ b/Documentation/ProjectFile/prj/t_geometry.md @@ -1 +1,5 @@ -Info about geometry... +Path to the `.gml` file. This file specifies the geometry for the use in boundary conditions. + +See \ref ogs_file_param__gml for the file format description. + +Alternativeley multiple \ref ogs_file_param__prj__meshes can be used. \ No newline at end of file diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md b/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md index 576add64edc..d3ff78f5cb0 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md @@ -1 +1,2 @@ -\ogs_missing_documentation +Referencing the process by name as defined in \ref ogs_file_param__prj__processes__process__name. + diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md b/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md index 576add64edc..46bfcf5b998 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md @@ -1 +1 @@ -\ogs_missing_documentation +Specifying time integration parameters of the process referenced in \ref ogs_file_attr__prj__time_loop__processes__process__ref. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md b/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md index 576add64edc..492228c85d0 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md @@ -1 +1 @@ -\ogs_missing_documentation +Referencing a nonlinear solver as defined by \ref ogs_file_param__prj__nonlinear_solvers__nonlinear_solver. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md index 576add64edc..eb5ca524faf 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md @@ -1 +1 @@ -\ogs_missing_documentation +Specifying the type of the time discretization scheme. See \ref ogs_file_param__prj__time_loop__processes__process__time_discretization cases for possible values. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md index 576add64edc..001fa978c97 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md @@ -1 +1,5 @@ -\ogs_missing_documentation +Defines how to fill up the time between \ref ogs_file_param__prj__time_loop__processes__process__time_stepping__FixedTimeStepping__t_initial and \ref ogs_file_param__prj__time_loop__processes__process__time_stepping__FixedTimeStepping__t_end. + +Consecutive different time steppings are defined by consecutive \ref ogs_file_param__prj__time_loop__processes__process__time_stepping__FixedTimeStepping__timesteps__pair definitions. + +If all defined pairs don't fill up the simulation time, the last pair repeats until \ref ogs_file_param__prj__time_loop__processes__process__time_stepping__FixedTimeStepping__t_end. Likewise, if the specified time steps add up to more than the simulation time, the last steps are dropped in order to fit the simulation time. Furthermore if simple adding or dropping of time steps cannot fit the simulation time, the last step will be to dropped to fit <tt><t_end>-<t_initial></tt> exactly. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md index 576add64edc..085fed5edc7 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a time stepping scheme. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md index 576add64edc..8f7e335bfe5 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md @@ -1 +1 @@ -\ogs_missing_documentation +Time step increment. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md index 576add64edc..df348b66495 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md @@ -1 +1 @@ -\ogs_missing_documentation +Repetition of time step increment \ref ogs_file_param__prj__time_loop__processes__process__time_stepping__FixedTimeStepping__timesteps__pair__delta_t. diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/t_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/t_type.md index 2cac2c7c0de..41a1b93799f 100644 --- a/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/t_type.md +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_stepping/t_type.md @@ -1 +1,2 @@ -The type of a time stepping method. +The type of a time stepping method. See \ref ogs_file_param__prj__time_loop__processes__process__time_stepping cases for possible values. + -- GitLab