From 6b1a3216276d82f8f294668cf77f46db6ad0aea3 Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Tue, 7 Aug 2018 15:17:26 +0200
Subject: [PATCH] [Doc] added input file documentation

---
 .../boundary_condition/Python/c_Python.md                    | 4 ++++
 .../boundary_condition/Python/t_bc_object.md                 | 2 ++
 .../boundary_condition/Python/t_flush_stdout.md              | 3 +++
 Documentation/ProjectFile/prj/t_python_script.md             | 5 +++++
 4 files changed, 14 insertions(+)
 create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/c_Python.md
 create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_bc_object.md
 create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_flush_stdout.md
 create mode 100644 Documentation/ProjectFile/prj/t_python_script.md

diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/c_Python.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/c_Python.md
new file mode 100644
index 00000000000..f0a0824aed5
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/c_Python.md
@@ -0,0 +1,4 @@
+Boundary condition using a Python script to compute its values.
+
+See ProcessLib::PythonBoundaryConditionPythonSideInterface for the Python-side
+BC interface.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_bc_object.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_bc_object.md
new file mode 100644
index 00000000000..5933158c031
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_bc_object.md
@@ -0,0 +1,2 @@
+The object (variable name) in the provided Python script that will be used for
+this BC.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_flush_stdout.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_flush_stdout.md
new file mode 100644
index 00000000000..8edea230fc2
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/Python/t_flush_stdout.md
@@ -0,0 +1,3 @@
+Determines if stdout should be flushed each time before and after passing control to the Python script.
+This might slow down operation, but ensures the right order of messages printed
+to stdout from Python and C++.
diff --git a/Documentation/ProjectFile/prj/t_python_script.md b/Documentation/ProjectFile/prj/t_python_script.md
new file mode 100644
index 00000000000..95a9399605d
--- /dev/null
+++ b/Documentation/ProjectFile/prj/t_python_script.md
@@ -0,0 +1,5 @@
+Path to a Python script file (absolute or relative to the prj file) that is
+executed by OpenGeoSys if OpenGeoSys has been built with Python support.
+
+This script can be used, e.g., to define boundary conditions that can be
+referenced from the prj file and used by OpenGeoSys.
-- 
GitLab