From 639f1d27207048bda34d33a2465a6daf91044ede Mon Sep 17 00:00:00 2001 From: Dmitri Naumov <dmitri.naumov@ufz.de> Date: Tue, 14 Jun 2016 14:44:53 +0200 Subject: [PATCH] Documentation initial_condition/Uniform/values. --- .../ProjectFile/initial_condition/Uniform/c_Uniform.md | 2 +- .../ProjectFile/initial_condition/Uniform/t_value.md | 7 ++++++- .../ProjectFile/initial_condition/Uniform/t_values.md | 8 ++++++++ 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 Documentation/ProjectFile/initial_condition/Uniform/t_values.md diff --git a/Documentation/ProjectFile/initial_condition/Uniform/c_Uniform.md b/Documentation/ProjectFile/initial_condition/Uniform/c_Uniform.md index bbf877d7841..b48a0e73fae 100644 --- a/Documentation/ProjectFile/initial_condition/Uniform/c_Uniform.md +++ b/Documentation/ProjectFile/initial_condition/Uniform/c_Uniform.md @@ -1 +1 @@ -\todo document +A uniform initial condition is constant in time and space. diff --git a/Documentation/ProjectFile/initial_condition/Uniform/t_value.md b/Documentation/ProjectFile/initial_condition/Uniform/t_value.md index bbf877d7841..2baa7650d47 100644 --- a/Documentation/ProjectFile/initial_condition/Uniform/t_value.md +++ b/Documentation/ProjectFile/initial_condition/Uniform/t_value.md @@ -1 +1,6 @@ -\todo document +The given floating point value will be set as initial condition for the +respective components on the entire domain. + +Same as values but for variables with one component only. For multi component +variables use the \ref ogs_file_param__initial_condition__Uniform__values +"values tag". diff --git a/Documentation/ProjectFile/initial_condition/Uniform/t_values.md b/Documentation/ProjectFile/initial_condition/Uniform/t_values.md new file mode 100644 index 00000000000..9f91fe3bec7 --- /dev/null +++ b/Documentation/ProjectFile/initial_condition/Uniform/t_values.md @@ -0,0 +1,8 @@ +A space separated list of floating point values, one for each component. +The length of the list must match the number of the variable's components. + +The given floating point values will be set as initial condition for the +respective components on the entire domain. + +For single component variables one can _optionally_ use the \ref +ogs_file_param__initial_condition__Uniform__value "value tag". -- GitLab