From 022aec8e4ad4f1d3090d603498ca2c55247013b0 Mon Sep 17 00:00:00 2001 From: Christoph Lehmann <christoph.lehmann@ufz.de> Date: Wed, 10 Oct 2018 14:03:26 +0200 Subject: [PATCH] [Doc] added input file docu --- .../CompareJacobians/c_CompareJacobians.md | 6 ++++++ .../jacobian_assembler/CompareJacobians/t_abs_tol.md | 4 ++++ .../CompareJacobians/t_fail_on_error.md | 2 ++ .../CompareJacobians/t_jacobian_assembler.md | 2 ++ .../jacobian_assembler/CompareJacobians/t_log_file.md | 8 ++++++++ .../CompareJacobians/t_reference_jacobian_assembler.md | 2 ++ .../jacobian_assembler/CompareJacobians/t_rel_tol.md | 4 ++++ 7 files changed, 28 insertions(+) create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/c_CompareJacobians.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_abs_tol.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_fail_on_error.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_jacobian_assembler.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_log_file.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_reference_jacobian_assembler.md create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_rel_tol.md diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/c_CompareJacobians.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/c_CompareJacobians.md new file mode 100644 index 00000000000..8185396890c --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/c_CompareJacobians.md @@ -0,0 +1,6 @@ +A Jacobian assembler that assembles the Jacobian in two different ways, compares +the resulting local Jacobians and writes extensive logs in the form of a Python +script if the provided tolerances are exceeded. + +Logging (and optionally program termination) is triggered only if both the +absolute and the relative tolerance are exceeded. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_abs_tol.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_abs_tol.md new file mode 100644 index 00000000000..1b1bdcd57ad --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_abs_tol.md @@ -0,0 +1,4 @@ +The absolute tolerance (component-wise) for the difference between the two +assembled local Jacobians. + +There is only one absolute tolerance value for all components of the Jacobian. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_fail_on_error.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_fail_on_error.md new file mode 100644 index 00000000000..7fa33d23b4b --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_fail_on_error.md @@ -0,0 +1,2 @@ +Whether OGS should be aborted if both the absolute and relative tolerance are +exceeded. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_jacobian_assembler.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_jacobian_assembler.md new file mode 100644 index 00000000000..bd27c7fd0fb --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_jacobian_assembler.md @@ -0,0 +1,2 @@ +The Jacobian assember whose assembled matrices will be used subsequently in the +global equation system. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_log_file.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_log_file.md new file mode 100644 index 00000000000..05251c45b79 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_log_file.md @@ -0,0 +1,8 @@ +The path to the file to which details of differing Jacobians are written. + +Finally, the file will contain a Python script that can be used to conveniently +examine the differences that occured. +The given path is an absolute path or a path relative to the working directory +of OGS. +The log file will be overwritten, even if no differences exceeding the +tolerances occur. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_reference_jacobian_assembler.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_reference_jacobian_assembler.md new file mode 100644 index 00000000000..ce02a50d494 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_reference_jacobian_assembler.md @@ -0,0 +1,2 @@ +The Jacobian assembler whose results are used only to check the assembled +matrices of the other Jacobian assembler. diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_rel_tol.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_rel_tol.md new file mode 100644 index 00000000000..67a16ad0dfd --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CompareJacobians/t_rel_tol.md @@ -0,0 +1,4 @@ +The relative tolerance (component-wise) for the difference between the two +assembled local Jacobians. + +There is only one relative tolerance value for all components of the Jacobian. -- GitLab