From 5242aa2cd915ee3b247190dcf9dbf342bc621360 Mon Sep 17 00:00:00 2001 From: Christoph Lehmann <christoph.lehmann@ufz.de> Date: Thu, 25 Aug 2016 21:38:27 +0200 Subject: [PATCH] [Doc] documented process variables --- .../ProjectFile/prj/process_variables/i_process_variables.md | 2 +- .../boundary_conditions/i_boundary_conditions.md | 2 +- .../boundary_conditions/t_boundary_condition.md | 4 +++- .../process_variables/process_variable/i_process_variable.md | 5 ++++- .../prj/process_variables/process_variable/t_components.md | 5 ++++- .../process_variable/t_initial_condition.md | 4 +++- .../prj/process_variables/process_variable/t_name.md | 2 +- 7 files changed, 17 insertions(+), 7 deletions(-) diff --git a/Documentation/ProjectFile/prj/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/process_variables/i_process_variables.md index 576add64edc..5d091f0a6e6 100644 --- a/Documentation/ProjectFile/prj/process_variables/i_process_variables.md +++ b/Documentation/ProjectFile/prj/process_variables/i_process_variables.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains definitions of process variables. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/i_boundary_conditions.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/i_boundary_conditions.md index 576add64edc..390cd469ebe 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/i_boundary_conditions.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/i_boundary_conditions.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains boundary conditions for the process variable. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/t_boundary_condition.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/t_boundary_condition.md index 576add64edc..fcf9ace1172 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/t_boundary_condition.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/t_boundary_condition.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Specifies a single boundary condition. + +See \ref ogs_file_param__boundary_condition. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/i_process_variable.md b/Documentation/ProjectFile/prj/process_variables/process_variable/i_process_variable.md index 576add64edc..c13a3da0772 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/i_process_variable.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/i_process_variable.md @@ -1 +1,4 @@ -\ogs_missing_documentation +Defines a single process variable. + +A process variable is a primary variable for which some process is solved. For a +process variable initial and boundary conditions can be specified. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/t_components.md b/Documentation/ProjectFile/prj/process_variables/process_variable/t_components.md index 576add64edc..f00a279ebf5 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/t_components.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/t_components.md @@ -1 +1,4 @@ -\ogs_missing_documentation +Sets the number of components of the process variable. + +It is one for scalar variables and greater than one for vectorial (or +theoretically even tensorial) process variables. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md b/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md index 576add64edc..faa2bccc16d 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Initial condition for the process variable. + +This setting references a \ref ogs_file_param__parameter "parameter" by name. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/t_name.md b/Documentation/ProjectFile/prj/process_variables/process_variable/t_name.md index 576add64edc..4e07f42e4a5 100644 --- a/Documentation/ProjectFile/prj/process_variables/process_variable/t_name.md +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/t_name.md @@ -1 +1 @@ -\ogs_missing_documentation +Name under which the process variable can be referenced. -- GitLab