Gerris Flow Solver Programming Course for Dummies

From Gerris

(Difference between revisions)
Jump to: navigation, search
Revision as of 17:29, 29 October 2007
Zaleski (Talk | contribs)
(Adapted the formatting to MediaWiki.)
← Previous diff
Current revision
GeordieMcBain (Talk | contribs)
(Preamble - misspellings; linked Users to their pages)
Line 1: Line 1:
-This wiki is an unfinished project ! +== Preamble ==
-== Preface ==+This course material is about Gerris, a general-purpose fluid mechanics code developed by [[User:Popinet|Stéphane Popinet]] at NIWA, Wellington, New Zealand. Gerris is a free, GPL-licensed, open source code available at [http://gfs.sf.net http://gfs.sf.net].
 +The intended audience is typical first-year science or engineering graduate students with either very little experience of C or with some Fortran knowledge, but willing to work hard and learn. The student should know simple C data types, pointers and functions but not structures.
-This course is about Gerris, a general-purpose fluid mechanics code developped by Stephane Popinet at NIWA, Wellington, New Zealand .+[[User:Zaleski|S. Zaleski]] has taught the course several times in Paris. In the actual course a lot of talking is done in addition to the material here. Each session is 30 minutes + 15 minutes of questions.
-The intended audience is typical first year graduate students with very little experience of C or some Fortran knowledge, but willing to work hard and learn.  
-Gerris is a free, open source code available at [[http://gfs.sf.net]] . +#[[Introduction to Gerris Programming]]
- +#[[The Fully Threaded Tree]]
-== Course 1 ==+#[[The Fluid Domain]]
- +#[[Programming the Advection Scheme]]
- +#[[The Gerris Object System]]
-=== Introduction ===+#[[An Example of Use of the Gerris Object System]]
- +#[[GfsView]]
- +#[[Values, macros and structures in Gerris]]
- +
-This course is about how Gerris ([[http://gfs.sf.net]] ) is programmed. It is intended to help in understanding the Gerris source code and learning how to modify it usefully. +
- +
-This course is not about the numerical methods in Gerris (however it would be good for students of this course to learn about them, for instance in the J. Comput. Phys. article) .+
- +
-Gerris is closely linked to Gts, the GNU triangulated surface library, also written by Stephane Popinet+
- +
-Gerris and Gts are programmed in a style analogous to that of Glib, Gnome and GTK . It is a style of C programming that offers several advantages: +
- +
-* Most aspects of Object-Oriented Programming (OOP) , such as the existence of classes with their own methods and inheritance.+
- +
-* The ability to interface to other programming languages. (As far as I know, this feature is not used in Gerris/Gts)+
- +
-To implement Object-Oriented Programming, Gerris/Gts uses its own “Object system”. This system is analogous to the Glib object system (Gobject), but not identical to it. Learning more about Gobject can be very useful. +
- +
-=== References ===+
- +
-References to the Gobject system (in order of ease of reading): +
- +
- +
- +
-[[http://en.wikipedia.org/wiki/GObject]]+
- +
-[[http://docs.programmers.ch/index.php/HOWTO_gobject]]+
- +
-[[http://library.gnome.org/devel/gobject/stable/index.html]]+
- +
-=== Useful tips ===+
- +
- +
- +
-==== Navigate using the TAGS file in emacs or vim ====+
- +
- - Create the TAGS file : <pre>+
-% cd src+
-% make tags+
-</pre>+
- +
-# In emacs: +
-## open any *.c or *.h file with emacs.+
-## Position the cursor on a function or variable. +
-## do ESC . to find its definition. (or M-. using the emacs Meta key convention ) +
-## do ESC * to return to the previous location (s) . +
-# In vim:+
-## to be written ...+
- +
- +
-==== No order in which to read the code ====+
- +
-There is no good order in which to read the code (I have not found it yet) +
- +
- +
-==== Keep a C precedence and associativity table nearby ====+
- +
-A lot of macros and functions such g_assert come from the Glib. +
-Keep a bookmark to the Glib documentation: [[http://library.gnome.org/devel/glib/unstable/index.html]]+
- +
- +
-=== C basics ===+
- +
-==== Introduction to Structures ====+
- +
- +
-<pre>+
-struct Point {+
- char name;+
- double x, y;+
-};+
-</pre>+
- +
-An example of usage+
- +
-<pre>+
-main()+
-{+
- +
-struct Point my_point; /* declaration */+
- +
-my_point.x = 0. ; +
-my_point.y = 1.;+
-my_point.name = ‘A’;+
-}+
-</pre>+
- +
-name, x and y are members of the structure of type “Point” called my_point. We also give it a name that can be exported (printed, passed to other functions) as a character. This example shows why it is useful to use structures to store several relevant informations or data together.+
- +
-==== An example: the structure GfsNorm in Gerris ====+
- +
-<pre>+
- +
-struct _GfsNorm {+
- gdouble bias, first, second, infty, w;+
-};+
-typedef struct _GfsNorm GfsNorm+
-</pre>+
- +
-From ''domain.h''. +
- +
-<pre>+
-GfsNorm gfs_domain_norm_residual (GfsDomain * domain,+
- FttTraverseFlags flags,+
- gint max_depth,+
- gdouble dt,+
- GfsVariable * res)+
-{+
- GfsNorm n;+
- gpointer data[2];+
- +
- g_return_val_if_fail (domain != NULL, n);+
- g_return_val_if_fail (res != NULL, n);+
- +
- gfs_norm_init (&n);+
- data[0] = res;+
- data[1] = &n;+
- gfs_domain_cell_traverse (domain, FTT_PRE_ORDER, flags, max_depth, +
- (FttCellTraverseFunc) add_norm_residual, data);+
-#ifdef HAVE_MPI+
- domain_norm_reduce (domain, &n);+
-#endif /* HAVE_MPI */+
- gfs_norm_update (&n);+
- +
- dt *= dt;+
- n.bias *= dt;+
- n.first *= dt;+
- n.second *= dt;+
- n.infty *= dt;+
- return n;+
-}+
-</pre>+
- +
-From ''domain.c''+
- +
-Notice the use of+
- +
-* glib basic types ''gdouble, gpointer''+
- +
-* glib functions ''g_return_val_if_fail''+
- +
-==== Structures that are related to other structures ====+

Current revision

Preamble


This course material is about Gerris, a general-purpose fluid mechanics code developed by Stéphane Popinet at NIWA, Wellington, New Zealand. Gerris is a free, GPL-licensed, open source code available at http://gfs.sf.net.

The intended audience is typical first-year science or engineering graduate students with either very little experience of C or with some Fortran knowledge, but willing to work hard and learn. The student should know simple C data types, pointers and functions but not structures.

S. Zaleski has taught the course several times in Paris. In the actual course a lot of talking is done in addition to the material here. Each session is 30 minutes + 15 minutes of questions.


  1. Introduction to Gerris Programming
  2. The Fully Threaded Tree
  3. The Fluid Domain
  4. Programming the Advection Scheme
  5. The Gerris Object System
  6. An Example of Use of the Gerris Object System
  7. GfsView
  8. Values, macros and structures in Gerris
Personal tools
communication