changeset 2513:dee86da87fdd

Added sphinx pages for Eilmer4.
author Peter Jacobs <peterj@mech.uq.edu.au>
date Fri, 24 Mar 2017 07:40:53 +1000
parents 21e97b45566f
children 664e6c281d05
files doc/sphinx/_static/eilmer4-image-from-heather.png doc/sphinx/codes.rst doc/sphinx/eilmer3.rst doc/sphinx/eilmer4.rst doc/sphinx/getting-started.rst doc/sphinx/reports-and-theses.rst
diffstat 6 files changed, 39 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
Binary file doc/sphinx/_static/eilmer4-image-from-heather.png has changed
--- a/doc/sphinx/codes.rst	Thu Mar 16 12:50:23 2017 +1000
+++ b/doc/sphinx/codes.rst	Fri Mar 24 07:40:53 2017 +1000
@@ -1,10 +1,9 @@
 The CFCFD Code Collection
 =========================
 
-For local and external collaborators, these are available via a public Mercurial repository.
+These codes are available via a public Mercurial repository.
 
-#. *eilmer3*: The current compresible-flow Navier-Stokes simulation code
-   for 2D and 3D flows. 
+#. *eilmer3*: A compresible-flow Navier-Stokes simulation code for 2D and 3D flows. 
    This has the best bits of mbcns2 and elmer2, together with a rebuilt
    thermochemistry module.
    We have changed the name to Eilmer, the correct spelling of the name of the
@@ -15,11 +14,14 @@
 #. *poshax3*: post-shock, one-dimensional flow with complex thermochemistry 
    and radiation.
 #. *photaura*: radiation toolset.
+#. *eilmer4*: Is our newest compressible flow simulation code for 2D and 3D flows.
+   It is a complete reworking of our flow simulation ideas into the D programming language.   
 
 .. toctree::
    :maxdepth: 2
 
    getting-started
+   eilmer4
    eilmer3
    l1d3
    imoc
--- a/doc/sphinx/eilmer3.rst	Thu Mar 16 12:50:23 2017 +1000
+++ b/doc/sphinx/eilmer3.rst	Fri Mar 24 07:40:53 2017 +1000
@@ -1,7 +1,7 @@
 Eilmer3
 =======
 
-Eilmer3 is our principal simulation code for 2D and 3D gas dynamics.
+Eilmer3 is a simulation code for 2D and 3D gas dynamics.
 It is a research and education code, suitable for the exploration of
 flows where the bounding geometry is not too complex.
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/eilmer4.rst	Fri Mar 24 07:40:53 2017 +1000
@@ -0,0 +1,20 @@
+Eilmer4
+=======
+
+Eilmer4 is our latest simulation code for 2D and 3D gas dynamics.
+It is a research and education code, suitable for the exploration of
+high-temperature compressible flows.
+
+.. figure:: _static/eilmer4-image-from-heather.png
+   :align: center
+   :scale: 50%
+
+   Unstructured-grid paver by Heather Muir, 2016.
+
+Source code and Documententation
+--------------------------------
+ 
+The full Eilmer4 source code, instructions and user guides are available in the
+`Bitbucket.org repository <https://bitbucket.org/cfcfd/dgd/>`_
+
+
--- a/doc/sphinx/getting-started.rst	Thu Mar 16 12:50:23 2017 +1000
+++ b/doc/sphinx/getting-started.rst	Fri Mar 24 07:40:53 2017 +1000
@@ -1,6 +1,9 @@
 Getting the codes and preparing to run them
 ===========================================
 
+If you are interested in just the Eilmer4 flow simulation code, skip these instructions
+and jump straight to the `Eilmer4 page on Bitbucket <https://bitbucket.org/cfcfd/dgd/>`_.
+ 
 The code repository
 -------------------
 The codes are available for download from a public Mercurial repository.
@@ -38,7 +41,7 @@
 Licence
 -------
 CFCFD program collection is a set of flow simulation tools for compressible fluids.
-Copyright (C) 1991-2016 Peter Jacobs, Rowan Gollan, Daniel Potter, 
+Copyright (C) 1991-2017 Peter Jacobs, Rowan Gollan, Daniel Potter, 
 Ingo Jahn, Anand Veeraragavan, Vince Wheatley, Daryl Bond, Chris James
 and other members of the CFCFD group.
 
--- a/doc/sphinx/reports-and-theses.rst	Thu Mar 16 12:50:23 2017 +1000
+++ b/doc/sphinx/reports-and-theses.rst	Fri Mar 24 07:40:53 2017 +1000
@@ -1,6 +1,15 @@
 Reports and Theses
 ==================
 
+Eilmer4
+-------
+
+The Eilmer4 User Guide describes how to set up and run simulations.  
+The companion gas model and geometry user guides describe the details of 
+the thermochemistry models and the geometry/grid generation modules.
+All of these reports are available, as PDF, 
+from the `Eilmer4 page on Bitbucket <https://bitbucket.org/cfcfd/dgd/>`_
+
 Eilmer3
 -------