diff --git a/Documentation/ProjectFile/prj/mesh/i_mesh.md b/Documentation/ProjectFile/prj/mesh/i_mesh.md index 11ed78b9ec0b7e61c6f2e191a45b0cd5a8cb48f5..a5c1b7bd72caeefe3b540eeb03afedeba4cdb6b8 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 8ef568698c327f9cc19687fdf0c959c276255f84..2d7a904f598d07218edaf77582abdd78a3b93c98 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 576add64edccf5d980a0ff86143dc43a7109a788..454647b9f0b52a88e468f192fba072a83a3e223c 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 f1ddc3cf01bead61d4c7fee6463e664b51daa865..6b92265a29f24f0590c6aab94f97e5b1c656e298 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 576add64edccf5d980a0ff86143dc43a7109a788..d3ff78f5cb0e19cd4c9bc636f660ac009b36a274 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 576add64edccf5d980a0ff86143dc43a7109a788..46bfcf5b9983b12173fa6fd184dbd1d5b6b4e9be 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 576add64edccf5d980a0ff86143dc43a7109a788..492228c85d04c5538a27c3d1ccdb2e1b3392b0d8 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 576add64edccf5d980a0ff86143dc43a7109a788..eb5ca524faf6fdd2bb2fa790977abd9fd166ee37 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 576add64edccf5d980a0ff86143dc43a7109a788..001fa978c97133358207373dfffaa354a41b02dd 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 576add64edccf5d980a0ff86143dc43a7109a788..085fed5edc79327381e1c32f75e0f83c89a2b4fa 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 576add64edccf5d980a0ff86143dc43a7109a788..8f7e335bfe56cfe5400b85492e875bdbc3e818cc 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 576add64edccf5d980a0ff86143dc43a7109a788..df348b66495cd72802f093d67bfc5e25a326899c 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 2cac2c7c0deff1b4f42f6fa915daca19e8c51d31..41a1b93799ff4e8e3c1cf435614980ce4e97272f 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. +