changeset 8:663bc627945e

Started sphinx documentation, to eventually replace the cfcfd web pages.
author Peter Jacobs <peterj@mech.uq.edu.au>
date Wed, 25 Jan 2012 15:02:56 +1000
parents 2c7745ef8722
children 28f0fb924574
files doc/sphinx/Makefile doc/sphinx/codes.rst doc/sphinx/conf.py doc/sphinx/eilmer3.rst doc/sphinx/getting-started.rst doc/sphinx/index.rst doc/sphinx/intro.rst doc/sphinx/l1d3.rst
diffstat 8 files changed, 705 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/Makefile	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CompressibleFlowCFD.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CompressibleFlowCFD.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/CompressibleFlowCFD"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CompressibleFlowCFD"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/codes.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,48 @@
+The CFCFD Code Collection
+=========================
+
+Current Codes
+-------------
+For local and external collaborators, these are available via a Mercurial repository.
+
+#. *eilmer3*: The current 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
+   patron monk of CFD and aeronautics.
+   See the wikipedia article http://en.wikipedia.org/wiki/Eilmer_of_Malmesbury
+#. *L1d3*: Lagrangian simulation of quasi-one-dimensional flow.
+#. *imoc*: interactive method-of-characteristics code, written in C+Tcl.
+
+.. toctree::
+   :maxdepth: 2
+
+   getting-started
+   eilmer3
+   l1d3
+
+Maintained Codes
+----------------
+Not actively developed but available to local collaborators through the Bazaar-ng repository.
+ 
+#. *bos*: Background-oriented schlieren (current but needs maintenance; new numpy)
+#. *elmer*: The first version of our time-dependent 3D flow simulation code.
+   C version built for LES simulations. (obsolete)
+#. *elmer2*: Second version using libgas2 thermochemsitry and written in C++. (obsolete)
+#. *L1d*: Lagrangian simulation of quasi-one-dimensional flow. (obsolete)
+#. *L1d2*: second version of this code build with libgas2 thermochemistry.
+   Written in C++. (current)
+#. *mb_cns*: Multiple-block compressible Navier-Stokes flow simulator.
+   This is the code corresponding to the 1996 report. (obsolete)
+#. *mbcns2*: second version using libgas2 and written in C++. (obsolete)
+#. *newt*: Newtonian flow approximation for hypersonics flows.
+#. *octvce*: Joseph's fast Euler code with hierarchical adaptive grid for 3D flows.
+#. *poshax*: one-dimensional flow with complex thermochemistry.
+#. *sdas*: firmware for simple data acquisition system for student Zuni projects.
+#. *sf3d_v4.1*: Ian Johnston's shock-fitting code for 3D flow.
+#. *sm_3d_plus*: space-marching code for 3D flow.  
+   (obsolete now that block-sequencing is part of eilmer3)
+#. *tds*: tunnel data server, software for both the server and the client
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/conf.py	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,220 @@
+# -*- coding: utf-8 -*-
+#
+# Compressible Flow CFD documentation build configuration file, created by
+# sphinx-quickstart on Wed Jan 25 11:33:56 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Compressible Flow CFD'
+copyright = u'2012, Peter Jacobs, Rowan Gollan and many others'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '3'
+# The full version, including alpha/beta/rc tags.
+release = '3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CompressibleFlowCFDdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'CompressibleFlowCFD.tex', u'Compressible Flow CFD Documentation',
+   u'Peter Jacobs, Rowan Gollan and many others', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'compressibleflowcfd', u'Compressible Flow CFD Documentation',
+     [u'Peter Jacobs, Rowan Gollan and many others'], 1)
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/eilmer3.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,88 @@
+Eilmer3
+=======
+
+Eilmer3 is our principal 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.
+
+Typical build and run procedure
+-------------------------------
+The new 2D/3D code Eilmer3 is built from source into an installation directory $HOME/e3bin/.  
+A typical build procedure (using the default TARGET=for_gnu) might be:
+
+| cd $HOME/cfcfd2/app/eilmer3/build
+| make install
+| make clean
+
+Or, if you want the MPI version of the code built as well:
+
+| cd $HOME/cfcfd2/app/eilmer3/build
+| make TARGET=for_openmpi install
+| make clean
+
+You may need to add the installation directory to your system's 
+search path and to Lua's search path.
+On a recent Linux system, this could be done by adding the lines
+
+| export PATH=${PATH}:${HOME}/e3bin
+| export LUA_PATH=${HOME}/e3bin/?.lua
+| export LUA_CPATH=${HOME}/e3bin/?.so
+
+to the .bash_profile or .bashrc file in your home directory.
+Note that it is not necessary to have the LUA_CPATH variable set 
+unless you want to access the Lua gas module from within 
+the user-defined (Lua) functions.
+You don't need it to run Eilmer3 otherwise.
+
+For running on some managed computers, such as our blackhole cluster, also add the following:
+
+| module load openmpi/1.2-gnu-4.1
+| module load swig
+
+IMPORTANT: Do NOT load lua as was done in the example for Elmer2.
+
+Then, try out the cone20-simple example.
+
+| mkdir $HOME/work; cd $HOME/work; mkdir 2D; cd 2D
+| mkdir cone20-simple; cd cone20-simple
+| cp $HOME/cfcfd2/examples/eilmer3/2D/cone20-simple/* .
+| ./cone20_run.sh  # exercise the shared-memory version of the code
+|        or
+| ./cone20_run_mpi.sh  # exercise the MPI version of the code
+
+This should generate a postscript figure of the drag coefficient history
+about a sharp 20-degree cone and also put the VTK data file into the plot/
+subdirectory.
+It is not really necessary to make all of the subdirectories as shown above,
+however, that arrangement reflects the directory tree that PJ uses.
+If you want him to come and look at your simulation files when things go wrong,
+use the same.
+If not, use whatever hierarchy you like.
+
+
+Other Notes
+-----------
+On Xserver for Linux (especially Ubuntu):
+
+* If Paraview crashes on exporting a bitmap image, try adding the line
+  
+  Option "AIGLX" "false"
+
+  to the Section "ServerLayout" in /etc/X11/xorg.conf
+
+* To use Paraview 3.6.1 on Ubuntu 9.04 or later,
+  it seems that we need to customize the look of the desktop 
+  by turning off the Visual Effects. 
+  This setting can be found in the System->Preferences->Appearance menu.
+
+* To get Paraview Screenshot to behave,
+  uncheck "Use Offscreen Rendering for Screenshots" button
+  in the Edit->Settings ("Options") dialog.
+  You will find the checkbutton under "Render View"->General.
+
+User Guide (PDF)
+----------------
+
+
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/getting-started.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,90 @@
+Getting Started
+===============
+
+Getting the current code collection
+-----------------------------------
+The codes are available for download via a Mercurial repository.
+
+| $ cd ~
+| $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3
+| $ cd cfcfd3/extern/
+| $ hg clone ssh://cfcfd3@triton/cea2-hg cea2
+
+Notes
+
+#. You will need a password for any access.  Please ask.
+#. To push code changes, you will need access via ssh.
+
+
+Your computational environment
+------------------------------
+The code collection comes as source code only so,
+to use any of them, you will need to compile and install them.
+
+To build and run the newer codes, you will need the following:
+
+* a Unix-like system with GNU-make, C and C++ compilers
+* popt (command-line parser) library and development files
+* readline library (including the header files, libreadline5-dev on Ubuntu)
+* Python + (with the numpy extension)
+* SWIG
+* Tcl/Tk + the BWidget library (to run the GUI program e3console.tcl)
+
+We have been able to get the programs to build on Linux, MacOS-X 
+(with a recent Xcode development environment) and Cygwin 1.7 (on MS-Windows).
+
+On MS-Windows, install the full kit of Cygwin (Python, X-Windows and all)
+and be careful not to have another Python installed outside of Cygwin.
+The multiple installations of Python seem not to play well together.
+
+Some other things that are useful:
+
+* awk
+* MetaPost (mpost) or, more recently, InkScape (for looking at and editing svg files)
+* GNUplot
+* Paraview or MayaVi or VisIt
+
+To a basic Fedora 16 installation, you should add the following packages:
+
+#. bzr
+#. gcc
+#. gcc-c++
+#. m4
+#. gcc-gfortran
+#. swig
+#. python-devel
+#. readline-devel (for Lua)
+#. popt-devel
+
+To a basic Ubuntu 10.04 installation, you should add the following packages and their dependencies:
+
+#. bzr
+#. bzrtools
+#. g++
+#. m4
+#. mpi-default-dev
+#. gfortran
+#. swig
+#. python-dev
+#. python-numpy
+#. libreadline-dev
+#. libpopt-dev
+#. tk
+#. bwidget
+#. gnuplot
+
+
+Getting the cfcfd2 (old) codes
+------------------------------
+The older cfcfd2 code collection is still available using bazaar-ng.
+To get (read-only) access via http, use the command:
+
+| cd $HOME
+| bzr branch http://cfcfdlocal@triton.pselab.uq.edu.au/bzr-cfcfd2 cfcfd2
+
+Notes
+
+#. You will need a password for bzr access.  Please ask.
+#. To push code changes, you will need access via ssh.
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/index.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,24 @@
+.. Compressible Flow CFD documentation master file, created by
+   sphinx-quickstart on Wed Jan 25 11:33:56 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+The Compressible-Flow CFD Project
+=================================
+
+Since the 1980s, we have been building compressible flow simulation codes. 
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+   codes
+
+.. comment out following bits
+   Indices and tables
+   ==================
+
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/intro.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,98 @@
+The CFCFD Group
+===============
+
+The Compressible-Flow CFD group is an informal group of academic staff
+postdoctoral fellows and postgraduate students within the Faculty of Engineering
+For many years, the main participants are from the Centre for Hypersonics
+and the Geothermal Energy Research Centre.
+Our common interest is the simulation of the flow of compressible fluids.
+
+In support of the experimental activities of the Centres, 
+special emphasis is placed on simulations of transient flows
+relevant to shock tunnel and expansion tube experiments and on
+quasi-steady flows relevant to turbomachinery.
+Computation is used for both the design of the experimental facilities themselves,
+the estimation of test-flow conditions,
+and the supporting analysis of data obtained from 
+project-oriented experiments such as the MUSES-C aeroshell.
+
+The group also undertakes a number of purely computational projects 
+in which the computer plays the part of a "numerical wind tunnel".
+Such projects have included the calibration of a reentry air-data system,
+for the HYFLEX flight vehicle,
+the optimisation of scramjet exhaust nozzle shapes, and
+the analysis of the scramjet inlet and combustor for the HyShot project.
+Thes applied studies motivate more abstract modelling efforts that
+aim to improve our simulation capability by developing novel phenomonological
+flow models and numerical codes that implement those models. 
+
+Compressible flow simulations pose a number of challenges to CFD codes:
+the fluid density can vary over several orders of magnitude, 
+shocks are extremely strong,
+and the high temperatures existing behind the shocks 
+lead to a strong coupling of aerothermodynamic and chemical effects.
+Specialised code development done within the group focuses on 
+dealing with the extremes of hypervelocity flow
+as produced in the T4 shock tunnel and X-series expansion tube facilities.
+Locally developed simulation codes exist for: 
+one-, two, and three-dimensional viscous flows; 
+flows with equilibrium and nonequilibrium chemistry;
+and rarefied flows.
+These codes are tailored to our specific needs, 
+provide capability that is not available in commercial CFD packages and
+form a training environment for the next generation of commercial
+code developers.
+An additional benefit to building our own software is that we find that the
+close interaction of CFD modellers and code writers with the experimenters
+leads us to look deeper into the modelling and instrumentation issues. 
+
+The inclusion of strongly interacting physical effects and large
+variations in length scales leads to the need to run our simulation
+codes on large, fast computers.
+The group presently has access to the University of Queensland's 
+SGI supercomputer, the national APAC facility and a number of local machines.
+
+Current group members
+---------------------
+Daryl Bond;
+Wilson Chan;
+Jason Czapla;
+David Gildfind;
+Rowan J. Gollan;
+Peter A. Jacobs;
+Michael N. Macrossan;
+Emilie Sauret;
+Carlos de Miranda Ventura;
+Vincent Wheatley;
+Fabian Zander.
+
+Past members and associates
+---------------------------
+Joanna M. Austin, University of Illinois, Urbana;
+Kevin J. Austin, UQ, Brisbane;
+Russell Boyce, ADFA Canberra;
+Chris S. Craddock, BMT, UK;
+Andrew Denman;
+Michael Elford;
+James M. Faddy;
+Tony Gardner,  DLR;
+Richard J. Goozee;
+Klaus Hannemann and Monika Hannemann, DLR, Goettingen;
+Haruko Ishikawa, Tokyo;
+Carolyn Jacobs; Ecole Centrale, Paris;
+Ian A. Johnston, DSTO, Adelaide;
+Charles Lilley, Melbourne;
+Andrew M. McGhee, Brisbane;
+Brendan O'Flaherty, WBM Pty Ltd, Brisbane;
+Paul J. Petrie-Repar, RPM-Turbo, Brisbane;
+Leon Prucha;
+Michael Scott; 
+Todd Silvester; 
+Ben Stewart;
+Joseph Tang, WBM Pty Ltd, Brisbane;
+Tina Weichel, Germany;
+Michael Wendt, CSIRO, Brisbane;
+Adriaan Window, Brisbane.
+
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/l1d3.rst	Wed Jan 25 15:02:56 2012 +1000
@@ -0,0 +1,7 @@
+L1d3
+====
+
+L1d3 is our specialist simulation code for quasi-one-dimensional gas dynamics.
+It is usually applied to the simulation of entire shock-tube or expansion-tube
+facilities and has a role to play in the design of new experimantal machines.
+