Add documentation

docs/.gitignore

@@ -1 +1,2 @@
 Pipfile.lock
+.venv

docs/conf.py

@@ -83,7 +83,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '.venv']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

docs/problem_description_file/problem_description.rst

@@ -24,6 +24,7 @@ However, some combinations or specifications do not make much sense, e.g., a cyl
    problem_description/matrix
    problem_description/disable_time_step_control
    problem_description/normalized_residual_tolerance
+   problem_description/residual_relative_tolerance
    problem_description/number_of_eq
    problem_description/energy
    problem_description/momentum

docs/problem_description_file/problem_description/residual_relative_tolerance.rst

@@ -0,0 +1,37 @@
+*********************************
+Residual Relative Tolerance
+*********************************
+
+::
+
+	Residual Relative Tolerance = <float>
+
+-----------------------
+Description / Usage
+-----------------------
+
+This is the per matrix version of this card. This overrides Residual Relative Tolerance for each matrix
+
+
+<float>
+    **tol,** a non-negative floating point number ( tol ≥ 0.0 ) specifying the
+    L\ :sub:`2` ratio convergence tolerance for the global nonlinear residual vector.
+
+The *Residual Relative Tolerance* card is not required; the default is 1e10 effectively turning it off.
+
+------------
+Examples
+------------
+
+Following is a sample card:
+::
+
+   MATRIX = 1
+       Residual Relative Tolerance      = 1e-6
+       Number of EQ = 3
+
+-------------------------
+Technical Discussion
+-------------------------
+
+

docs/problem_description_file/solver_specifications.rst

@@ -52,6 +52,7 @@ report by Schunk, et al. (2002) for an overview and further usage tips.
    solver_specifications/normalized_residual_tolerance
    solver_specifications/normalized_correction_tolerance
    solver_specifications/residual_ratio_tolerance
+   solver_specifications/residual_relative_tolerance
    solver_specifications/pressure_stabilization
    solver_specifications/pressure_stabilization_scaling
    solver_specifications/pressure_stabilization_disable_tau_sens

docs/problem_description_file/solver_specifications/residual_relative_tolerance.rst

@@ -0,0 +1,39 @@
+*********************************
+Residual Relative Tolerance
+*********************************
+
+::
+
+	Residual Relative Tolerance = <float>
+
+-----------------------
+Description / Usage
+-----------------------
+
+Residual Relative Tolerance requires the convergence to reach a relative
+tolerance compared to the initial normalized residual.
+
+For example if your initial normalized residual is :math:`r0=1e2` and you set the relative tolerance to :math:`rt=1e-6`
+then you must reach :math:`rf <= r0*rt`
+
+
+<float>
+    **tol,** a non-negative floating point number ( tol ≥ 0.0 ) specifying the
+    L\ :sub:`2` ratio convergence tolerance for the global nonlinear residual vector.
+
+The *Residual Relative Tolerance* card is not required; the default is 1e10 effectively turning it off.
+
+------------
+Examples
+------------
+
+Following is a sample card:
+::
+
+   Residual Relative Tolerance      = 1e-6
+
+-------------------------
+Technical Discussion
+-------------------------
+
+