aerodynamics Files

#-----------------------------------------------------------------------------------------------------------------------------------
#-
#-aerodynamics freeware package
#-http://sourceforge.net/projects/aerodynamics/
#-aerodynamics - version 1.0.1 (oct 2011)
#-
#-aerodynamics
#-Distributed under the GNU General Public Licence. See the file COPYING.
#-project distribution at http://sourceforge.net/projects/aerodynamics
#-
#-GUI bugs/comments:
#-P. Cao Huu Thien <pcht@users.sourceforge.net>
#-
#-CFD/math bugs/comments:
#-G.A. Gerolymos <gagerolymos@users.sourceforge.net>
#-I. Vallet <isabellevallet@users.sourceforge.net>
#-
#-Wed Oct 19 16:11:16 CEST 2011
#-
#-----------------------------------------------------------------------
#-
#-This program is free software: you can redistribute it and/or modify
#-it under the terms of the GNU General Public License as published by
#-the Free Software Foundation, either version 3 of the License, or
#-(at your option) any later version.
#-
#-This program is distributed in the hope that it will be useful,
#-but WITHOUT ANY WARRANTY; without even the implied warranty of
#-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#-GNU General Public License for more details.
#-
#-You should have received a copy of the GNU General Public License
#-along with this program.  If not, see <http://www.gnu.org/licenses/>.
#-
#-----------------------------------------------------------------------
#-       ---------------------------------------------------------------
#-Credits---------------------------------------------------------------
#-       ---------------------------------------------------------------
#-----------------------------------------------------------------------

I. Credits
  
  WHEN PUBLISHING OR PRESENTING RESULTS COMPUTED WITH THE aerodynamics package
  PLEASE CITE
  
  [1] Gerolymos G.A., Senechal D., Vallet I.
      J. Comp. Phys. 228 (2009) 8481--8524
      "Very-high-order WENO schemes"
  
  [2] Gerolymos G.A., Vallet I.
      Int. J. Num. Meth. Fluids 61 (2009) 185-219
      "Implicit meanflow-multigrid algorithms for Reynolds-stress model computation of 3-D anisotropy-driven and compressible flows"
  
#-----------------------------------------------------------------------
#-            ----------------------------------------------------------
#-Installation----------------------------------------------------------
#-            ----------------------------------------------------------
#-----------------------------------------------------------------------

II. Installation

II.1 What's new
The 1.0.0 release of the aerodynamics programmes suite (apr 2011), includes
a Tcltk GUI, initially developed by Patrick Cao. It was designed to provide
online help for building the applications.

II.2 Installation
If you are installing on a 32bit processor, you should first recompile
the binaries as in step II.3. If you are installing on a 64bit processor,
you may proceed as follows.

Once you download aerodynamics_1_0_0.gz to the working directory
            wherever_you_tar_xvfz/
execute the command
            tar xvfz aerodynamics_1_0_0.gz
The executable file
            wherever_you_tar_xvfz/aerodynamics_1_0_0/install
can be used for installation. The shell detects whether you have root privileges or not,
so that if you want a root installation you must be root when you execute install.

1) root install prompts for the installation directories of the executables
   (AERODYNAMICS_BIN; default is /usr/local/bin) and of the examples+docs+sources+GUI files
   (AERODYNAMICS; default is /usr/local/aerodynamics). The environment variable
   AERODYNAMICS=$AERODYNAMICS is added into /etc/profile.d,
   and $AERODYNAMICS_BIN is added to the PATH by appending /etc/profile.
2) user install prompts for the installation directory of the examples+docs+sources+GUI files
   (AERODYNAMICS; default is $HOME/aerodynamics) and automatically chooses
   (AERODYNAMICS_BIN=$AERODYNAMICS/bin).
   AERODYNAMICS=$AERODYNAMICS and $AERODYNAMICS_BIN is added to the PATH,
   by appending these to the file $HOME/.bash_profile.

The final part of the install copies the files to the destinations. These options
should cover most needs (assuming you use bash shell). You can edit the file
            wherever_you_tar_xvfz/aerodynamics_1_0_0/install
for further customization.

If you are using bash shell and a 64bit processor, you are ready to compute,
as in III.

II.3 Compilers and 32bit procesors
The executables are standalone 64bit binaries, compiled using gfortran4.3.
These are easily recompiled, using the Makefile in
            wherever_you_tar_xvfz/aerodynamics_1_0_0/src/
either for 32bit processors, or for other f90 compilers (use FC option for make).
It is simpler to recompile before using install. The command
            make FC=... FCFLAGS=... all install
compiles all source codes, and copies executables to
            wherever_you_tar_xvfz/aerodynamics_1_0_0/bin
You are now ready to use install as in II.2
More on compilation in V and VI.

#-----------------------------------------------------------------------
#-     -----------------------------------------------------------------
#-Usage-----------------------------------------------------------------
#-     -----------------------------------------------------------------
#-----------------------------------------------------------------------

III. Usage

After installation the GUI is launched by the command
            aerodynamics
You can have a rather advanced tutorial using the GUI and the online manuals.
Some file are required, when needed. Sample files of this category, are in
            $AERODYNAMICS/examples/
and there is a built-in helper (button help at the top-right-corner) of the
GUI, which brings up the html pages.

The code was written initially for Tcl 8.5.1 and later,
but was simplified to also run with Tcl 8.4.13 and later.
The current version (aerodynamics 1.0.1) was tested using Tcl 8.6b1.
For 2-D and 3-D visualizations we use paraview as a separate software,
so you should also install paraview (or mayavi), but this is probably
already for CFD users.
The 1-D plots use gnuplot (4.2.2 to 4.4.3).

#-----------------------------------------------------------------------
#-        --------------------------------------------------------------
#-Contents--------------------------------------------------------------
#-        --------------------------------------------------------------
#-----------------------------------------------------------------------

IV. Contents

The release contains:

1: source files                                                             in $AERODYNAMICS/src/
2: binary (executable) Linux files (double precision)                       in $AERODYNAMICS/bin/
3: make_file to built the binaries                                          in $AERODYNAMICS/src/
4: documentation                                                            in $AERODYNAMICS/doc/index.html
5: examples of runs with these files (see documentation)                    in $AERODYNAMICS/examples/
6. GUI                                                                      in $AERODYNAMICS/gui-tk/

The release does not contain:

7: programming manual: in writting

#-----------------------------------------------------------------------
#-         -------------------------------------------------------------
#-Compilers-------------------------------------------------------------
#-         -------------------------------------------------------------
#-----------------------------------------------------------------------

V. Compilers

The GUI is written in tcl, and interpreted by wish, so that no compilation
is required. For the executables

NOTE: ALWAYS USE THE APPROPRIATE COMPILER DIRECTIVE TO UPGRADE to r*8
---------------------------------------------------------------------

Binaries were built for Linux using 4 different compilers (64-bit platforms), and for NEC SX8 computers.

1    : Standard Linux platforms
       These are standalone binaries, so you do not need to install the compiler to run them.

1.1  : real*8 double precision arithmetic

1.1.1: gfortran 4.6.1 (gcc version 4.6.1): FCFLAGS = -O3 -fdefault-real-8 -fconvert=big-endian -ffree-line-length-none -static-libgcc -static-libgfortran

1.1.2: g95                               : FCFLAGS = -O3 -r8 -fendian=big -Wno=115 -static-libgcc

1.1.3: ifort                             : NOT TESTED

#-----------------------------------------------------------------------
#-                              ----------------------------------------
#-Compilation using the Makefile----------------------------------------
#-                              ----------------------------------------
#-----------------------------------------------------------------------

VI. Compilation using the Makefile

The Makefile is in $AERODYNAMICS/src/. Compilation directives (FCFLAGS),
with the above definitions of FC are included in the Makefile.

To compile with gfortran (default)  : make clean; make all FC=gfortran    (default)
                g95                 : make clean; make all FC=g95