Commit a7f8a8a7 authored by Lambert Theisen's avatar Lambert Theisen
Browse files

Fix some documentation

parent 701ddfbb
......@@ -172,7 +172,8 @@ Developer Tips
Python notes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Get current work directory
- Get current work directory:
.. code-block:: python
......@@ -180,7 +181,7 @@ Python notes
cwd = os.getcwd()
print(cwd)
- Latex font for matplotlib
- Latex font for matplotlib:
.. code-block:: python
......@@ -189,7 +190,7 @@ Python notes
plt.rc('text', usetex=True)
plt.rc('font', family='serif')
- Get system path where modules are searched
- Get system path where modules are searched:
.. code-block:: python
......@@ -201,6 +202,7 @@ Create new version tag
1. Add CHANGELOG entry
2. Adapt version in `conf.py` for docs
3. Change badge in ``README.rst``
4. Change version in program information printing
Gitlab CI Setup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -212,7 +214,7 @@ Gitlab CI Setup
- Run local: ``gitlab-runner exec docker --docker-privileged build`` or with ``build`` replaced by job name
- maybe local vars have to be change to use local Docker images because ``CI_REGISTRY``,... are not set
A example gitlab runner ``config/toml`` in ``~/.gitlab-runner`` can look like:
An example gitlab runner ``config/toml`` in ``~/.gitlab-runner`` can look like:
.. code-block:: toml
......@@ -300,11 +302,6 @@ The steps can be summarized as:
Contact
--------------------------------------------------------------------------------
.. image:: ./media/mathcces.png
:width: 400px
:alt: mathcces
:target: http://www.mathcces.rwth-aachen.de
:Author:
| Lambert Theisen
| lambert.theisen@rwth-aachen.de
......
......@@ -65,8 +65,9 @@ def main():
# Usage: <path_to_program> <input_file>
# Goto case folder:
cd tests/heat
python3 ../../src/fenicsR13.py inputs/heat_01_coeffs_p1p1_stab.yml
cd tests/r13
python3 ../../src/fenicsR13.py inputs/ \
r13_1_coeffs_nosources_norot_inflow_p1p1p1p1p1_stab.yml
"""
print_information()
......
......@@ -30,9 +30,11 @@ class H5Mesh:
Construct the object.
This includes:
(#) Read mesh
(#) Read subdomains
(#) Read boudnaries
(#) Read mesh
(#) Read subdomains
(#) Read boudnaries
"""
if not os.path.isfile(h5_file):
raise Exception(f"{h5_file} not found")
......
......@@ -2,8 +2,6 @@
"""
Module to store the postprocessor classes.
Currently, only Psotprocessor class present.
"""
from itertools import chain
......
......@@ -20,7 +20,15 @@ class Solver:
Class to store the actual solver.
Possible order of methods in context of convergence study
(see main program): "mesh=meshes[i=0]", "__init__", "assemble()", "solve()", "write()", "...", "mesh=meshes[i+1]", "__init__", "..."
(see main program):
"mesh=meshes[i=0]",
"__init__", "assemble()",
"solve()",
"write()",
"...",
"mesh=meshes[i+1]",
"__init__",
"..."
Parameters
----------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment