File	Date	Author	Commit
build	2013-02-16	mbellier	[3cf3ff] Comment ça la branche est vide ?!
cahier	2013-02-16	mbellier	[3cf3ff] Comment ça la branche est vide ?!
report	2013-04-11	Christian LASSERRE	[e9ad36] Merge branch 'master' of ssh://git.code.sf.net/...
src	2013-04-11	Christian LASSERRE	[e9ad36] Merge branch 'master' of ssh://git.code.sf.net/...
win	2013-03-29	mbellier	[631aac] Merge branch 'master' of ssh://git.code.sf.net/...
.gitignore	2013-03-27	S.Castelli	[a46b85] Merge branch 'master' of ssh://git.code.sf.net/...
CMakeLists.txt	2013-04-11	Christian LASSERRE	[e9ad36] Merge branch 'master' of ssh://git.code.sf.net/...
README.txt	2013-03-29	Christian LASSERRE	[7a603f] merge - rapport

Read Me

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
             AWESOME FLUID SOLVER - ENSEIRB-Matmeca - 2013
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

DESCRIPTION

 This project provides librairies to solve the Navier-Stokes equation,
 and an interface to simulate a fluid in 2D. 

 The source code can be found in the following directories:
    * src/solver : solving librairies;
    * src/display: interface.


COMPILING

      cmake $ROOT_DIRECTORY
      make

For example from "build" : 
    
      cmake .
      make
      ./bin/FluidSolver

Run make test to run performance test and results test.
Make sure that obstacles are disable.

INSTRUCTIONS

      $PATH_TO_BIN/FluidSolver

 Use the option '-h' or '--help' to show the usage message.
 
 This message shows the different options available.

 For instance, the option '-config' can be used to restore
 a previously saved configuration, with the actual screen 
 resolution. (see '-lconfig' to list saved configurations,
 more details in the help screen)


SHORTCUTS

 * Keyboard

      SPACE .......... Pause / Resume the simulation
      ENTER .......... Change display mode
      F .............. Reset the fluid
      R .............. Reset the fluid and the sources
      BACKSPACE ...... Reset the system (fluid, sources & obstacles)
      V .............. Toggle velocity field drawings
      M .............. Toggle mouse velocity modifications
      + .............. Increase cursor size
      - .............. Reduce cursor size
      F1 ............. Toggle fullscreen
      Ctrl-S ......... Save the simulation
      Ctrl-O ......... Restore a saved simulation
      ESC, Ctrl-W .... Quit

 * Mouse
 
      Left button ........... Inject fluid density
      Right button .......... Remove fluid density
      Ctrl  + Left button ... Add a density source
      Ctrl  + Right button .. Add obstacle
      Shift + Left button ... Add a directionnal source
      	    a) first click to set the source position
            b) second click to set direction and speed

      Wheel Up ....... Increase cursor radius
      Wheel Down ..... Decrease cursor radius


CREDITS

 BELLIER Maxime
 BRISSET Clement
 CASTELLI Stephane
 LACHDHAF Sami
 LASSERRE Christian
 VAGLICA Sylvain	

 www.enseirb-matmeca.fr