[pyfr] 23/32: Update User and Developer Guides.
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Thu Apr 21 08:21:52 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 5bb8d7c123d1cd537529bbb780c8d864379a22bc
Author: Peter Vincent <p.vincent at imperial.ac.uk>
Date: Thu Mar 31 08:28:20 2016 +0100
Update User and Developer Guides.
---
doc/src/developer_guide.rst | 33 ++++++++++++++++++++++++++++++---
doc/src/user_guide.rst | 43 ++++++++++++++++++++++++++++++++++++++-----
2 files changed, 68 insertions(+), 8 deletions(-)
diff --git a/doc/src/developer_guide.rst b/doc/src/developer_guide.rst
index 7225d59..c0e6a58 100644
--- a/doc/src/developer_guide.rst
+++ b/doc/src/developer_guide.rst
@@ -224,7 +224,7 @@ inheritance diagram:
Backend
-------
-A `Backend`_ holds information/data for a backend. There are three types
+A `Backend`_ holds information/data for a backend. There are four types
of `Backend`_ available in PyFR |release|:
.. autoclass:: pyfr.backends.cuda.base.CUDABackend
@@ -235,6 +235,14 @@ of `Backend`_ available in PyFR |release|:
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
+.. autoclass:: pyfr.backends.mic.base.MICBackend
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
.. autoclass:: pyfr.backends.opencl.base.OpenCLBackend
:members:
:undoc-members:
@@ -256,6 +264,7 @@ Types of `Backend`_ are related via the following inheritance diagram:
.. inheritance-diagram:: pyfr.backends.cuda.base
pyfr.backends.opencl.base
pyfr.backends.openmp.base
+ pyfr.backends.mic.base
:parts: 1
Pointwise Kernel Provider
@@ -275,7 +284,7 @@ the context for Mako (i.e. details about the `Backend`_ etc.) and then
uses Mako to begin rendering the `PyFR-Mako`_ specification. When Mako
encounters a :code:`pyfr:kernel` an instance of a `Kernel Generator`_
is created, which is used to render the body of the
-:code:`pyfr:kernel`. There are three types of `Pointwise Kernel
+:code:`pyfr:kernel`. There are four types of `Pointwise Kernel
Provider`_ available in PyFR |release|:
.. autoclass:: pyfr.backends.cuda.provider.CUDAPointwiseKernelProvider
@@ -286,6 +295,14 @@ Provider`_ available in PyFR |release|:
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
+.. autoclass:: pyfr.backends.mic.provider.MICPointwiseKernelProvider
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
.. autoclass:: pyfr.backends.opencl.provider.OpenCLPointwiseKernelProvider
:members:
:undoc-members:
@@ -308,6 +325,7 @@ inheritance diagram:
.. inheritance-diagram:: pyfr.backends.openmp.provider
pyfr.backends.cuda.provider
pyfr.backends.opencl.provider
+ pyfr.backends.mic.provider
pyfr.backends.base.kernels.BasePointwiseKernelProvider
:parts: 1
@@ -319,7 +337,7 @@ into low-level platform-specific code. Specifically, a `Kernel
Generator`_ has a method named :code:`render`, which applies `Backend`_
specific regex and adds `Backend`_ specific 'boiler plate' code to
produce the low-level platform-specific source -- which is compiled,
-linked, and loaded. There are three types of `Kernel Generator`_
+linked, and loaded. There are four types of `Kernel Generator`_
available in PyFR |release|:
.. autoclass:: pyfr.backends.cuda.generator.CUDAKernelGenerator
@@ -330,6 +348,14 @@ available in PyFR |release|:
:exclude-members: _abc_cache, _abc_negative_cache,
_abc_negative_cache_version, _abc_registry
+.. autoclass:: pyfr.backends.mic.generator.MICKernelGenerator
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :private-members:
+ :exclude-members: _abc_cache, _abc_negative_cache,
+ _abc_negative_cache_version, _abc_registry
+
.. autoclass:: pyfr.backends.opencl.generator.OpenCLKernelGenerator
:members:
:undoc-members:
@@ -351,6 +377,7 @@ Types of `Kernel Generator`_ are related via the following inheritance diagram:
.. inheritance-diagram:: pyfr.backends.cuda.generator.CUDAKernelGenerator
pyfr.backends.opencl.generator.OpenCLKernelGenerator
pyfr.backends.openmp.generator.OpenMPKernelGenerator
+ pyfr.backends.mic.generator.MICKernelGenerator
:parts: 1
=========
diff --git a/doc/src/user_guide.rst b/doc/src/user_guide.rst
index 92b3aa2..c33a141 100644
--- a/doc/src/user_guide.rst
+++ b/doc/src/user_guide.rst
@@ -39,6 +39,17 @@ or greater. The backend requires:
1. `CUDA <https://developer.nvidia.com/cuda-downloads>`_ >= 4.2
2. `pycuda <http://mathema.tician.de/software/pycuda/>`_ >= 2011.2
+MIC Backend
+^^^^^^^^^^^
+
+The MIC backend targets Intel Xeon Phi co-processors. The backend
+requires:
+
+1. ICC >= 14.0
+2. Intel MKL >= 11.1
+3. Intel MPSS >= 3.3
+4. `pymic <https://github.com/01org/pyMIC>`_ >= 0.7 (post commit 4d8a2da)
+
OpenCL Backend
^^^^^^^^^^^^^^
@@ -68,6 +79,14 @@ have one of the following partitioners installed:
1. `metis <http://glaros.dtc.umn.edu/gkhome/views/metis>`_ >= 5.0
2. `scotch <http://www.labri.fr/perso/pelegrin/scotch/>`_ >= 6.0
+Importing CGNS Meshes
+^^^^^^^^^^^^^^^^^^^^^
+
+To import CGNS meshes it is necessary to have the following installed:
+
+1. `CGNS <http://cgns.github.io/>`_ >= 3.3 (develop branch post commit
+ e0faea6)
+
Installation
------------
@@ -96,7 +115,8 @@ PyFR |release| uses three distinct file formats:
The following commands are available from the ``pyfr`` program:
1. ``pyfr import`` --- convert a `Gmsh
- <http:http://geuz.org/gmsh/>`_ .msh file into a PyFR .pyfrm file.
+ <http:http://geuz.org/gmsh/>`_ .msh file or `CGNS
+ <http://cgns.github.io/>`_ .cgns file into a PyFR .pyfrm file.
Example::
@@ -181,6 +201,19 @@ Example::
device-id = round-robin
gimmik-max-nnz = 512
+[backend-mic]
+^^^^^^^^^^^^^^^^
+
+Parameterises the MIC backend with
+
+1. ``device-id`` --- for selecting which device(s) to run on:
+
+ *int* | ``local-rank``
+
+1. ``mkl-root`` --- path to MKL root directory:
+
+ *string*
+
[backend-opencl]
^^^^^^^^^^^^^^^^
@@ -1012,13 +1045,13 @@ with
*float*
- - ``theta`` --- azimuth angle of inflow measured in
- the x-y plane relative to the global positive x-axis
+ - ``theta`` --- azimuth angle (in degrees) of inflow measured
+ in the x-y plane relative to the positive x-axis
*float*
- - ``phi`` --- inclination angle of inflow measured
- relative to the global positive z-axis
+ - ``phi`` --- inclination angle (in degrees) of inflow measured
+ relative to the positive z-axis
*float*
--
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