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 0000000000000000000000000000000000000000..8185396890cb2e64695d68e07749f821ec090f0d --- /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 0000000000000000000000000000000000000000..1b1bdcd57ad9ef091d97e06fe6bcc79aa57d3367 --- /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 0000000000000000000000000000000000000000..7fa33d23b4b1e9b54e716af5391853bbabec7421 --- /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 0000000000000000000000000000000000000000..bd27c7fd0fbedec4504af0776fab622ae45b0b7b --- /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 0000000000000000000000000000000000000000..05251c45b79f10d38401e6fc000dcbfaa82ab9a9 --- /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 0000000000000000000000000000000000000000..ce02a50d494e7fae95bcf748f477cb62f912abba --- /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 0000000000000000000000000000000000000000..67a16ad0dfd8592d356a1bde85c823e52ad15e03 --- /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.