[Docu] Complete documentation.

ufz · Oct 11, 2019 · 6689f64 · 6689f64
1 parent 9a7bad5
commit 6689f64
Show file tree

Hide file tree

Showing 15 changed files with 15 additions and 0 deletions.
diff --git a/Documentation/ProjectFile/prj/chemical_system/knobs/i_knobs.md b/Documentation/ProjectFile/prj/chemical_system/knobs/i_knobs.md
@@ -0,0 +1 @@
+an optional tag for numerical setting.
diff --git a/Documentation/ProjectFile/prj/chemical_system/knobs/t_max_iterations.md b/Documentation/ProjectFile/prj/chemical_system/knobs/t_max_iterations.md
@@ -0,0 +1 @@
+an optional tag for setting maximum number of iteration. The default value is 100.
diff --git a/...ation/ProjectFile/prj/chemical_system/knobs/t_relative_convergence_tolerance.md b/...ation/ProjectFile/prj/chemical_system/knobs/t_relative_convergence_tolerance.md
@@ -0,0 +1 @@
+an optional tag for setting relative convergence tolerance. The default value is 1e-12.
diff --git a/Documentation/ProjectFile/prj/chemical_system/knobs/t_scaling.md b/Documentation/ProjectFile/prj/chemical_system/knobs/t_scaling.md
@@ -0,0 +1 @@
+an option tag for scaling odinary differential equations.
diff --git a/Documentation/ProjectFile/prj/chemical_system/knobs/t_tolerance.md b/Documentation/ProjectFile/prj/chemical_system/knobs/t_tolerance.md
@@ -0,0 +1 @@
+An optional tag for setting tolerance used by optimization solver. The default value is 1e-15.
diff --git a/Documentation/ProjectFile/prj/chemical_system/surface/i_surface.md b/Documentation/ProjectFile/prj/chemical_system/surface/i_surface.md
@@ -0,0 +1 @@
+define surface complexion model.
diff --git a/Documentation/ProjectFile/prj/chemical_system/surface/site/i_site.md b/Documentation/ProjectFile/prj/chemical_system/surface/site/i_site.md
@@ -0,0 +1 @@
+define properties of surface site.
diff --git a/Documentation/ProjectFile/prj/chemical_system/surface/site/t_mass.md b/Documentation/ProjectFile/prj/chemical_system/surface/site/t_mass.md
@@ -0,0 +1 @@
+specify mass of substance in unit of gram.
diff --git a/Documentation/ProjectFile/prj/chemical_system/surface/site/t_name.md b/Documentation/ProjectFile/prj/chemical_system/surface/site/t_name.md
@@ -0,0 +1 @@
+specify substance of surface site.
diff --git a/Documentation/ProjectFile/prj/chemical_system/surface/site/t_site_density.md b/Documentation/ProjectFile/prj/chemical_system/surface/site/t_site_density.md
@@ -0,0 +1 @@
+specify site density in unit of sites per square nanometer.
diff --git a/...ntation/ProjectFile/prj/chemical_system/surface/site/t_specific_surface_area.md b/...ntation/ProjectFile/prj/chemical_system/surface/site/t_specific_surface_area.md
@@ -0,0 +1 @@
+specify specific surface area of substance in unit of square meter per gram.
diff --git a/Documentation/ProjectFile/prj/chemical_system/t_use_high_precision.md b/Documentation/ProjectFile/prj/chemical_system/t_use_high_precision.md
@@ -0,0 +1 @@
+Optional tag. Th default setting is to use high precision. Convergence criterion is thus set to 1e-12. When this tag is explicitly set to false, convergence criterion will be reduced to 1e-8. 
diff --git a/Documentation/ProjectFile/prj/chemical_system/user_punch/i_user_punch.md b/Documentation/ProjectFile/prj/chemical_system/user_punch/i_user_punch.md
@@ -0,0 +1 @@
+contain a number of statements for calculating custom secondary variables.
diff --git a/Documentation/ProjectFile/prj/chemical_system/user_punch/t_headline.md b/Documentation/ProjectFile/prj/chemical_system/user_punch/t_headline.md
@@ -0,0 +1 @@
+specify a number of custom secondary variables.
diff --git a/Documentation/ProjectFile/prj/chemical_system/user_punch/t_statement.md b/Documentation/ProjectFile/prj/chemical_system/user_punch/t_statement.md
@@ -0,0 +1 @@
+state how to calculate custom secondary variables.