Mercurial > hg > cfcfd3

changeset 16:a587197c464d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sphinx docs: Have the top-level files pretty much in order. Have rescued the Theses and Reports content from the old web pages and found a new home for it in the new order of things. The actual PDF files for theses are not in the repository but are in my ~/papers/theses directory and get copied over to the web server after the Sphinx build is done.
author Peter Jacobs <peterj@mech.uq.edu.au>
date Tue, 31 Jan 2012 18:51:05 +1000
parents 65ee38f08bbe
children a54503138206
files doc/sphinx/case-studies.rst doc/sphinx/codes.rst doc/sphinx/estcj.rst doc/sphinx/getting-started.rst doc/sphinx/imoc.rst doc/sphinx/index.rst doc/sphinx/intro.rst doc/sphinx/nenzfr.rst doc/sphinx/old-codes.rst doc/sphinx/poshax3.rst doc/sphinx/reports-and-theses.rst doc/sphinx/update-web-server.sh
diffstat 12 files changed, 293 insertions(+), 54 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/case-studies.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,12 @@
+Case Studies
+============
+
+This material supports journal and conference papers that have been published.
+
+Drummond Tunnel Simulation
+--------------------------
+Animated-GIF-images_ for simulation of a complete reflected shock tunnel showing a vortex mechanism for flow contamination.
+
+.. _Animated-GIF-images: ./drummond_simulation/
+
+
--- a/doc/sphinx/codes.rst	Mon Jan 30 12:22:46 2012 +0100
+++ b/doc/sphinx/codes.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -1,8 +1,6 @@
 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
@@ -14,6 +12,8 @@
    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.
+#. *poshax3*: post-shock, one-dimensional flow with complex thermochemistry 
+   and radiation.
 
 .. toctree::
    :maxdepth: 2
@@ -21,28 +21,8 @@
    getting-started
    eilmer3
    l1d3
+   imoc
+   poshax3
+   estcj
+   nenzfr
 
-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/estcj.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,6 @@
+ESTCj
+=====
+
+Equilibrium Shock Tube Conditions (junior)
+
+
--- a/doc/sphinx/getting-started.rst	Mon Jan 30 12:22:46 2012 +0100
+++ b/doc/sphinx/getting-started.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -1,19 +1,29 @@
-Getting Started
-===============
+Getting the codes and preparing to run them
+===========================================
+
+The code repository
+-------------------
+The codes are available for download from a Mercurial repository.
+To make a clone of the repository:
 
-Getting the current code collection
------------------------------------
-The codes are available for download via a Mercurial repository.
+| $ cd $HOME
+| $ hg clone https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/ cfcfd3
+
+This takes about 40 seconds on campus at UQ.  
+It may take much longer, depending on your internet connection.
 
-| $ cd ~
-| $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3
-| $ cd cfcfd3/extern/
-| $ hg clone ssh://cfcfd3@triton/cea2-hg cea2
+To see what's changed:
+
+| $ cd cfcfd3
+| $ hg incoming https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/
+| ...
+| $ hg pull -u https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/
 
 Notes
 
 #. You will need a password for any access.  Please ask.
-#. To push code changes, you will need access via ssh.
+#. You can read but not write with the "cfcfdlocal" username.
+#. Some usernames (by negotiation) may push changesets back to the repository.
 
 
 Your computational environment
@@ -74,17 +84,16 @@
 #. 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:
+SSH access to the repository for developers
+-------------------------------------------
+Alternative access to the Mercurial repository for developers is possible via ssh.
+You will need the password or your public key installed for any access.  Please ask.
 
-| 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.
+| $ cd ~
+| $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3
+| $ cd cfcfd3/extern/
+| $ hg clone ssh://cfcfd3@triton/cea2-hg cea2
 
 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/imoc.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,10 @@
+imoc
+====
+
+Interactive method-of-characteristics code for irrotational flow of an ideal-gas.
+It sounds limited but MOC has the nice design capability of being able to specify 
+what upstream flow that you have, what downstream flow you would like, 
+and then be able to compute the flow field in between.
+
+
+
--- a/doc/sphinx/index.rst	Mon Jan 30 12:22:46 2012 +0100
+++ b/doc/sphinx/index.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -13,6 +13,9 @@
 
    intro
    codes
+   reports-and-theses
+   case-studies
+   old-codes
 
 .. comment out following bits
    Indices and tables
--- a/doc/sphinx/intro.rst	Mon Jan 30 12:22:46 2012 +0100
+++ b/doc/sphinx/intro.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -70,7 +70,7 @@
 ---------------------------
 Joanna M. Austin, University of Illinois, Urbana;
 Kevin J. Austin, UQ, Brisbane;
-Russell Boyce, ADFA Canberra;
+Russell Boyce, UQ, Brisbane;
 Chris S. Craddock, BMT, UK;
 Andrew Denman;
 Michael Elford;
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/nenzfr.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,7 @@
+NENZFr
+======
+
+Nonequilibrium Nozzle Flow (reloaded)
+
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/old-codes.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,81 @@
+Semi-retired (Old) 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
+
+
+Getting the 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.
+#. Even if you have ssh access, we'd like to keep this repository
+   static at revision 1212.  All new work should be going into the 
+   cfcfd3 repository.
+
+
+Other Archived Codes
+--------------------
+These are in various states of repair and are not being updated. 
+However, they continue to be useful for the odd shock tunnel job within the group.
+They can be found in the alt_app directory of the old repository.
+
+#. *MONC Version 4.8* Allan Paull's data acquisition and display program.
+#. *SM_3D* Space Marching Code as per Report 2/95.
+#. *MOC_87* Interactive Turbo-Pascal-3 program for the Method of Characteristics (1987)
+#. *MOC_95* Peter Eang's (incomplete) work on MOC (1995). 
+   I think that we'll finish this job with one of the newer scripting languages 
+   such as Python or Tcl/Tk. See IMOC above.
+#. *ConeFlow* Simon Sanderson's cone flow code. 
+   Includes FORTRAN source code with DOS executable from 1989.
+#. *ESTC* Malcolm McIntosh's Equilibrium Shock Tube Conditions code. 
+   Includes FORTRAN source code with DOS executable from some date between 1968 and 1990. 
+   (Use ESTCj instead if you have a Python interpreter and the CEA software.)
+#. *NENZF* Nonequilibrium nozzle flow code from Lordi et.al. 
+   Includes FORTRAN source code with DOS executable from 1988. 
+   This is another old code which has been updated to run on PC's.
+#. *SHOCK* A replacement for ESTC at low temperatures. 
+   Originally written by Richard Morgan and Rob Casey in BASIC. 
+   Updated for fortran on an IBM 3081 by Craig Brescianini, 1988.
+#. *STN* A replacement for ESTC and NENZF for equilibrium air and nitrogen. 
+   Written in FORTRAN-77 by Rob Krek and PJ, 1993. Updated 1995.
+#. *EQSTATE/CREK* Generalised one dimensional flow with finite-rate chemical reactions.
+   FORTRAN code that used to be run on an IBM 3081. There seems to be a DOS version also. 
+   Bob Bakos might know some more about this program.
+#. *SHARC* Craig Brescianini's finite difference code; 
+   developed for his PhD work on scramjet simulations.
+#. *NASA MOC* This neat Method of Characteristics program was written by J. M. Forster.
+   Updated for DOS compilers by PJ, May 1997. 
+   See the beginning of the source code for more information.
+#. *Gary Allen's Tube code* A program (in C) for shock tube simulations; 
+   derived from Michael Macrossan's FORTRAN program.
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/poshax3.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,5 @@
+poshax3
+=======
+
+Post-shock one-dimensional flow with complex chemistry and radiation.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sphinx/reports-and-theses.rst	Tue Jan 31 18:51:05 2012 +1000
@@ -0,0 +1,115 @@
+Reports and Theses
+==================
+
+Eilmer3
+-------
+
+Eilmer3-User-Guide_ describes how to set up and run simulations with Eilmer3.
+
+.. _Eilmer3-User-Guide: ./pdf/eilmer3-user-guide.pdf
+
+Eilmer3-Theory-Book_ describes the detailed calculations 
+that are done for a flow simulation.
+
+.. _Eilmer3-Theory-Book: ./pdf/eilmer3-theory-book.pdf
+
+MB_CNS
+------
+MB_CNS and mbcns2 are the earlier generation 2D flow simulation codes.
+These have been superseded by Eilmer3.
+ 
+Report-2004-10_ is the MB_CNS Example book.
+
+.. _Report-2004-10: ./pdf/example_book.pdf
+
+ICASE-Interim-Report-18_ (1991) on the Navier-Stokes solver CNS4U. CNS4U was eventually superceded by MB_CNS, and this report by the Eilmer3-Theory-Book_
+
+.. _ICASE-Interim-Report-18: ./pdf/cns4u.pdf
+
+Report-10-96_ on MB_CNS updates the documentation on the multiple-block version of the Navier-Stokes code. 
+
+.. _Report-10-96: ./pdf/mb_cns.pdf
+
+Report-2005-10_ describes the Python-based input format for mb_cns.
+
+.. _Report-2005-10: ./pdf/scriptit.pdf
+
+L1d
+---
+Report-13-98_ is the documentation for theory behind the Lagrangian 1-D program. 
+
+.. _Report-13-98: ./pdf/l1d_98.pdf
+
+Report-2005-09_ describes the newer, Python-based input format.
+
+.. _Report-2005-09: ./pdf/l_script.pdf
+
+IMOC
+----
+Report-3-00_ describes the user interface to the Interactive Method-of-Characteristics program.
+Note that, although the current web copy is a bit broken, the code and
+documentation is in the code repository.
+
+.. _Report-3-00: ./imoc/index.html
+ 
+Theses
+------
+
+Dan-Potter-PhD-Thesis_ "Modeling of radiating shock layers for atmospheric entry at Earth and Mars".
+
+.. _Dan-Potter-PhD-Thesis: ./theses/dan-potter-phd-thesis-may-2011.pdf
+
+Rowan-Gollan-PhD-Thesis_ "The Computational Modelling of High-Temperature Gas
+Effects with Application to Hypersonic Flows".
+
+.. _Rowan-Gollan-PhD-Thesis: ./theses/n33694032_PhD_submission.pdf
+
+Kevin-Austin-PhD-Thesis_ "Evolutionary Design of Robust Flight Control for a Hypersonic Aircraft"
+
+.. _Kevin-Austin-PhD-Thesis: ./theses/kevin-austin-phd-thesis-june-2002.pdf
+
+Chris-Craddock-PhD-Thesis_ "Computational Optimization of Scramjets and Shock Tunnel Nozzles"
+
+.. _Chris-Craddock-PhD-Thesis: ./theses/chris-craddock-phd-thesis-aug-1999.pdf
+
+Michael-Elford-MSc-Thesis_ "Validation of a CFD Solver for Hypersonic Flows"
+
+.. _Michael-Elford-MSc-Thesis: ./theses/michael-elford-masters-thesis-sep-2005.pdf
+
+James-Faddy-MSc-Thesis_ "Computational Modelling for Shock Tube Flows"
+
+.. _James-Faddy-MSc-Thesis: ./theses/james-faddy-masters-thesis-aug-2000.pdf
+
+Richard-Goozee-PhD-Thesis_ "Simulation of a Complete Shock Tunnel using Parallel Computer Codes"
+
+.. _Richard-Goozee-PhD-Thesis: ./theses/richard-goozee-phd-thesis-apr-2003.pdf
+
+Haruko-Ishikawa-PhD-Thesis_ "Investigations of Optimum Design of Heat Exchangers of Thermoacoustic Engines"
+
+.. _Haruko-Ishikawa-PhD-Thesis: ./theses/haruko-ishikawa-phd-thesis-dec-1999.pdf
+
+Ian-Johnston-PhD-Thesis_ "Simulation of Flow Around Blunt-Nosed Vehicles for the Calibration of Air-Data Systems"
+
+.. _Ian-Johnston-PhD-Thesis: ./theses/ian-johnston-phd-thesis-jan-1999-export.pdf
+
+Charles-Lilley-PhD-Thesis_ "A Macroscopic Chemistry Method for the Direct Simulation of Nonequilibrium Gas Flows"
+
+.. _Charles-Lilley-PhD-Thesis: ./theses/charles-lilley-phd-thesis-jun-2005.pdf
+
+Paul-Petrie-Repar-PhD-Thesis_ "Numerical Simulation of Diaphragm Rupture"
+
+.. _Paul-Petrie-Repar-PhD-Thesis: ./theses/paul-petrie-repar-phd-thesis-dec-1997.pdf
+
+Ben-Stewart-PhD-Thesis_ "Predicted Scramjet Testing Capabilities of the Proposed RHYFL-X Expansion Tube"
+
+.. _Ben-Stewart-PhD-Thesis: ./theses/ben-stewart-phd-thesis-oct-2004.pdf
+
+Vince-Wheatley-MSc-Thesis_ "Modelling Low-Density Flow in Hypersonic Impulse Facilities"
+
+.. _Vince-Wheatley-MSc-Thesis: ./theses/vince-wheatley-masters-thesis-aug-2001.pdf
+
+Peter-Jacobs-PhD-Thesis_ "Nonlinear Dynamics of Piecewise-Constant Vorticity Distributions in an Inviscid Fluid"
+
+.. _Peter-Jacobs-PhD-Thesis: ./theses/peter-jacobs-phd-thesis-may-1987.pdf
+
+
--- a/doc/sphinx/update-web-server.sh	Mon Jan 30 12:22:46 2012 +0100
+++ b/doc/sphinx/update-web-server.sh	Tue Jan 31 18:51:05 2012 +1000
@@ -1,10 +1,21 @@
 #! /bin/bash
-echo "About to rsync html files to viking"
-echo "A password will have to be supplied for each rsync."
-echo "First one..."
-rsync -av _build/html/ peterj@viking.mech.uq.edu.au:/var/www/html/cfcfd-new/
-echo "Second one..."
-rsync -av ../pdf peterj@viking.mech.uq.edu.au:/var/www/html/cfcfd-new/
+DEST=peterj@viking.mech.uq.edu.au:/var/www/html/cfcfd-new/
+
+echo "About to rsync html files to viking."
+echo "A password may have to be supplied for each rsync."
+echo "Note that we assume several external directories"
+echo "(of theses, etc) are available."
+
+echo "1. Sphinx-generated HTML docs..."
+rsync -av _build/html/ ${DEST}
+echo "2. Theses and reports..."
+rsync -av ../pdf ${DEST}
+echo "3. Theses..."
+rsync -av ~/papers/theses ${DEST}
+echo "4. Case study GIFs..."
+rsync -av ~/papers/drummond_simulation ${DEST}
+echo "5. IMOC HTML docs..."
+rsync -av ~/cfcfd3/app/imoc/doc/ ${DEST}/imoc/
 echo "Done."