[pyfr] 79/88: Update documentation.
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Wed Nov 16 12:05:33 UTC 2016
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch master
in repository pyfr.
commit 37379e96152bf94ce59600f498b24db8761e4ec6
Author: Peter Vincent <p.vincent at imperial.ac.uk>
Date: Mon Sep 19 01:36:50 2016 +0100
Update documentation.
---
doc/src/conf.py | 4 ++-
doc/src/developer_guide.rst | 81 +++++++++++++++++++++++++++++++++++++++------
doc/src/home.rst | 19 ++++-------
doc/src/theory.rst | 5 +++
doc/src/user_guide.rst | 4 +--
5 files changed, 86 insertions(+), 27 deletions(-)
diff --git a/doc/src/conf.py b/doc/src/conf.py
index 34c5e39..7d3202e 100644
--- a/doc/src/conf.py
+++ b/doc/src/conf.py
@@ -40,7 +40,9 @@ graphviz_output_format = 'svg'
inheritance_graph_attrs = dict(
center='true',
layout='dot',
- rankdir='TB')
+ rankdir='LR',
+ ranksep='0.11',
+ splines='ortho')
inheritance_node_attrs = dict(
color='"#333333"',
fillcolor='"#d8e6b8"',
diff --git a/doc/src/developer_guide.rst b/doc/src/developer_guide.rst
index c0e6a58..81c9baf 100644
--- a/doc/src/developer_guide.rst
+++ b/doc/src/developer_guide.rst
@@ -24,10 +24,10 @@ Controller
A `Controller`_ acts to advance the simulation in time. Specifically, a
`Controller`_ has a method named :code:`advance_to` which advances a
-`System`_ to a specified time. There are two types of `Controller`_
+`System`_ to a specified time. There are three types of `Controller`_
available in PyFR |release|:
-.. autoclass:: pyfr.integrators.controllers.NoneController
+.. autoclass:: pyfr.integrators.std.controllers.StdNoneController
:members:
:undoc-members:
:inherited-members:
@@ -35,7 +35,7 @@ available in PyFR |release|:
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
-.. autoclass:: pyfr.integrators.controllers.PIController
+.. autoclass:: pyfr.integrators.std.controllers.StdPIController
:members:
:undoc-members:
:inherited-members:
@@ -43,10 +43,20 @@ available in PyFR |release|:
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
+.. autoclass:: pyfr.integrators.dual.controllers.DualNoneController
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+
Types of `Controller`_ are related via the following inheritance
diagram:
-.. inheritance-diagram:: pyfr.integrators.controllers
+.. inheritance-diagram:: pyfr.integrators.std.controllers
+ pyfr.integrators.dual.controllers
:parts: 1
Stepper
@@ -54,10 +64,10 @@ Stepper
A `Stepper`_ acts to advance the simulation by a single time-step.
Specifically, a `Stepper`_ has a method named :code:`step` which
-advances a `System`_ by a single time-step. There are five types of
+advances a `System`_ by a single time-step. There are 11 types of
`Stepper`_ available in PyFR |release|:
-.. autoclass:: pyfr.integrators.steppers.EulerStepper
+.. autoclass:: pyfr.integrators.std.steppers.StdEulerStepper
:members:
:undoc-members:
:inherited-members:
@@ -65,7 +75,7 @@ advances a `System`_ by a single time-step. There are five types of
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
-.. autoclass:: pyfr.integrators.steppers.RK4Stepper
+.. autoclass:: pyfr.integrators.std.steppers.StdRK4Stepper
:members:
:undoc-members:
:inherited-members:
@@ -73,7 +83,54 @@ advances a `System`_ by a single time-step. There are five types of
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
-.. autoclass:: pyfr.integrators.steppers.RK34Stepper
+.. autoclass:: pyfr.integrators.std.steppers.StdRK34Stepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+.. autoclass:: pyfr.integrators.std.steppers.StdRK45Stepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+.. autoclass:: pyfr.integrators.std.steppers.StdTVDRK3Stepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+.. autoclass:: pyfr.integrators.dual.steppers.BDF2DualStepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+.. autoclass:: pyfr.integrators.dual.steppers.BDF3DualStepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
+.. autoclass:: pyfr.integrators.dual.steppers.BackwardEulerDualStepper
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+.. autoclass:: pyfr.integrators.dual.pseudosteppers.DualPseudoRK4Stepper
:members:
:undoc-members:
:inherited-members:
@@ -81,7 +138,7 @@ advances a `System`_ by a single time-step. There are five types of
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
-.. autoclass:: pyfr.integrators.steppers.RK45Stepper
+.. autoclass:: pyfr.integrators.dual.pseudosteppers.DualPseudoTVDRK3Stepper
:members:
:undoc-members:
:inherited-members:
@@ -89,7 +146,7 @@ advances a `System`_ by a single time-step. There are five types of
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
-.. autoclass:: pyfr.integrators.steppers.TVDRK3Stepper
+.. autoclass:: pyfr.integrators.dual.pseudosteppers.DualPseudoEulerStepper
:members:
:undoc-members:
:inherited-members:
@@ -99,7 +156,9 @@ advances a `System`_ by a single time-step. There are five types of
Types of `Stepper`_ are related via the following inheritance diagram:
-.. inheritance-diagram:: pyfr.integrators.steppers
+.. inheritance-diagram:: pyfr.integrators.dual.steppers
+ pyfr.integrators.dual.pseudosteppers
+ pyfr.integrators.std.steppers
:parts: 1
System
diff --git a/doc/src/home.rst b/doc/src/home.rst
index fcdb450..e2c288e 100644
--- a/doc/src/home.rst
+++ b/doc/src/home.rst
@@ -23,20 +23,12 @@ derived from the Mako templating engine. The current release (PyFR
- Platforms - CPU Clusters, Nvidia GPU Clusters, AMD GPU Clusters, Intel
Xeon Phi Clusters
- Spatial Discretisation - High-Order Flux Reconstruction
-- Temporal Discretisation - Explicit Runge-Kutta
+- Temporal Discretisation - Explicit and Implicit (via Dual
+ Time-Stepping)
- Precision - Single, Double
- Mesh Files Imported - Gmsh (.msh), CGNS (.cgns)
- Solution Files Exported - Unstructured VTK (.vtu, .pvtu)
-Who is Developing PyFR?
------------------------
-
-PyFR is being developed in the `Vincent Lab
-<https://www.imperial.ac.uk/aeronautics/research/vincentlab/>`_,
-Department of Aeronautics, Imperial College London, UK. More details
-about the development team are available
-`here <http://www.pyfr.org/team.php>`_.
-
How do I Cite PyFR?
-------------------
@@ -56,6 +48,7 @@ Sciences Research Council <http://www.epsrc.ac.uk/>`_, `Innovate UK
<https://www.gov.uk/government/organisations/innovate-uk>`_, the
`European Commission
<http://ec.europa.eu/programmes/horizon2020/>`_,
-`BAE Systems <http://www.baesystems.com/>`_, and
-`Airbus <http://www.airbus.com/>`_. We are also grateful for hardware
-donations from Nvidia, Intel, and AMD.
+`BAE Systems <http://www.baesystems.com/>`_,
+`Airbus <http://www.airbus.com/>`_, and the
+`Air Force Office of Scientific Research <http://www.wpafb.af.mil/afrl/afosr>`_.
+We are also grateful for hardware donations from Nvidia, Intel, and AMD.
diff --git a/doc/src/theory.rst b/doc/src/theory.rst
index 6f4cfcc..0609883 100644
--- a/doc/src/theory.rst
+++ b/doc/src/theory.rst
@@ -57,6 +57,11 @@ correction function. Linear stability issues are discussed in:
Problems on Tetrahedra. D. M. Williams, A. Jameson. Journal of
Scientific Computing, Volume 59, Pages 721-759, 2014
<http://link.springer.com/article/10.1007%2Fs10915-013-9780-2>`_
+- `An Extended Range of Stable-Symmetric-Conservative Flux Reconstruction
+ Correction Functions. P. E. Vincent, A. M. Farrington, F. D. Witherden,
+ A. Jameson. Computer Methods in Applied Mechanics and Engineering,
+ Volume 296, Pages 248-272, 2015
+ <http://www.sciencedirect.com/science/article/pii/S0045782515002418>`_
Non-Linear Stability
--------------------
diff --git a/doc/src/user_guide.rst b/doc/src/user_guide.rst
index 54dee3c..a646a3a 100644
--- a/doc/src/user_guide.rst
+++ b/doc/src/user_guide.rst
@@ -67,7 +67,7 @@ OpenMP Backend
The OpenMP backend targets multi-core CPUs. The backend requires:
-1. GCC >= 4.7
+1. GCC >= 4.9
2. A BLAS library compiled as a shared library
(e.g. `OpenBLAS <http://www.openblas.net/>`_)
@@ -226,7 +226,7 @@ Parameterises the MIC backend with
*int* | ``local-rank``
-1. ``mkl-root`` --- path to MKL root directory:
+2. ``mkl-root`` --- path to MKL root directory:
*string*
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pyfr.git
More information about the debian-science-commits
mailing list