Mercurial > hg > cfcfd3
changeset 24:35bd8af5f52a
Sphinx doc changes to fill out L1d3 intro. Also, add scipy to dependency list.
author | Peter Jacobs <peterj@mech.uq.edu.au> |
---|---|
date | Sun, 05 Feb 2012 08:56:28 +1000 |
parents | 058e04377099 |
children | 09ac92797952 |
files | doc/sphinx/eilmer3.rst doc/sphinx/getting-started.rst doc/sphinx/l1d3.rst |
diffstat | 3 files changed, 76 insertions(+), 25 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/sphinx/eilmer3.rst Sun Feb 05 07:25:39 2012 +1000 +++ b/doc/sphinx/eilmer3.rst Sun Feb 05 08:56:28 2012 +1000 @@ -8,25 +8,25 @@ 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: +A typical build procedure (using the default TARGET=for_gnu) might be:: -| cd $HOME/cfcfd2/app/eilmer3/build -| make install -| make clean + $ cd $HOME/cfcfd3/app/eilmer3/build + $ make install + $ make clean -Or, if you want the MPI version of the code built as well: +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 + $ cd $HOME/cfcfd3/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 +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 + $ 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 @@ -34,21 +34,23 @@ 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: +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 + $ 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. +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 + $ mkdir $HOME/work; cd $HOME/work; mkdir 2D; cd 2D + $ mkdir cone20-simple; cd cone20-simple + $ cp $HOME/cfcfd3/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/ @@ -64,9 +66,9 @@ ----------- On Xserver for Linux (especially Ubuntu): -* If Paraview crashes on exporting a bitmap image, try adding the line +* If Paraview crashes on exporting a bitmap image, try adding the line:: - Option "AIGLX" "false" + Option "AIGLX" "false" to the Section "ServerLayout" in /etc/X11/xorg.conf @@ -93,6 +95,8 @@ Source Code Docs ---------------- +The following documentation is tentative and experimental. +Use the PDF files above; they are the primary documents. .. toctree:: :maxdepth: 2
--- a/doc/sphinx/getting-started.rst Sun Feb 05 07:25:39 2012 +1000 +++ b/doc/sphinx/getting-started.rst Sun Feb 05 08:56:28 2012 +1000 @@ -36,7 +36,7 @@ * 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) +* Python + (with the numpy and scipy extensions) * SWIG * Tcl/Tk + the BWidget library (to run the GUI program e3console.tcl) @@ -63,6 +63,7 @@ #. gcc-gfortran #. swig #. python-devel +#. scipy #. readline-devel (for Lua) #. popt-devel @@ -77,6 +78,7 @@ #. swig #. python-dev #. python-numpy +#. python-scipy #. libreadline-dev #. libpopt-dev #. tk
--- a/doc/sphinx/l1d3.rst Sun Feb 05 07:25:39 2012 +1000 +++ b/doc/sphinx/l1d3.rst Sun Feb 05 08:56:28 2012 +1000 @@ -5,3 +5,48 @@ 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. +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/cfcfd3/app/L1d3/build + $ make install + $ make clean + $ cd ../../../lib/plot/build + $ make INSTALL_DIR=$HOME/e3bin 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. + +Run a quick example of gas accelerating a piston:: + + $ mkdir $HOME/work; cd $HOME/work + $ rsync -av /home/peterj/cfcfd3/examples/L1d3 . + $ cd L1d3/piston/ + $ ./run_and_plot_piston_sim.sh + $ gv piston_log_p.ps + +If you have ghostview installed, you should now be looking at +a space-time diagram of the expanding gas. +The upstream-face of the piston is the right, curved boundary. + + +Documentation +------------- +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 +