ryujin 2.1.1 revision ae95f0746689649c34c5726a2385af071c7c8efd
Usage instructions

Convenience Makefile

The Makefile found in the repository only contains a number of convenience targets and its use is entirely optional. It will create a subdirectory build and run cmake to configure the project. The executable will be located in build/run. The convenience Makefile contains the following additional targets:

make debug - switch to debug build and compile program
make release - switch to release build and compile program
make edit_cache - runs ccmake in the build directory
make edit - open build/run/ryujin.prm in default editor
make run - run the program (with default config file build/run/ryujin.prm)

Runtime parameter files

The build system create an executable build/run/ryujin that takes an optional parameter file as single argument. If run without an argument it will try to open a parameter file ryujin.prm in the working directory of the executable (that is build/run):

cd build/run
./ryujin # uses ryujin.prm
./ryujin my_parameter_file.prm

You can find a number of example parameter files in the prm subdirectory:

default.prm - all available parameters and their default values
euler-validation.prm - analytic isentropic vortex solution for validating the Euler configuration
navier_stokes-validation.prm - analytic becker solution for validating the Navier-Stokes configuration
navier_stokes-airfoil.prm - compute C_F/C_P values for the ONERA OAT15a airfoil
navier_stokes-shocktube.prm - Navier Stokes shocktube benchmark (see Daru & Tenaud, Computers & Fluids, 38(3):664-676, 2009)

Compile time options

For a complete list of compile-time options have a look at the Compile Time Options page.

You can set and change compile time options conveniently via ccmake, for example by using the convenience makefile

make edit_cache

or by calling ccmake by hand:

cd build
ccmake .

The most important compile-time options are DIM to select the spatial dimension ("1","2", or "3") and CMAKE_BUILD_TYPE to switch between a debug build ("debug") or a release build ("release"). Other compile-time options are NUMBER to specify whether the program should use double-precision ("double") or single-precision ("float") arithmetic, and various debugging and instrumentation toggles.

Most of the other compile-time options are marked as advanced and only visible in ccmake by changing to the advanced view (press "t"). They are best kept at their default values.