diff options
| author | eschnett <eschnett@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2011-07-02 23:06:23 +0000 |
|---|---|---|
| committer | eschnett <eschnett@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2011-07-02 23:06:23 +0000 |
| commit | 067fb40ec3ecc89821f559b60eecd451c49fb6a2 (patch) | |
| tree | 028253e9e6f0ac4d7999defe686a7936e9c4a5e5 /doc/UsersGuide | |
| parent | 17635e9238ddf993f9ccd962d637f3d08f806cfc (diff) | |
Correct documentation of if statements in schedule
Change the documented allowed "if" statements in schedule files from
if(CCTK_EQUALS(<parameter>, <value>)) { ... }
to
if(<expression>) { ... }
which is what is actually allowed (and commonly used).
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4709 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide')
| -rw-r--r-- | doc/UsersGuide/Appendices.tex | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index a9995888..f95abc8a 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -1027,12 +1027,14 @@ constructs using the parameter data base. These can be nested, and have the general form: \begin{alltt} -if (CCTK_Equals(<\var{parameter}>,<\var{string}>)) +if (<\var{conditional-expression}>) \{ [<\var{assignments}>] [<\var{schedule blocks}>] \}\end{alltt} +<\var{conditional-expression}> can be any valid C construct evaluating +to a truth value. Such conditionals are evaluated only at program startup, and are used to pick between different static schedule options. For dynamic scheduling, the {\tt SCHEDULE WHILE} construction should be used. |