#include <petscoptions.h> PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])Collective
| comm | - communicator that shares GUI | |
| prefix | - options prefix for all options displayed on window (optional) | |
| title | - short descriptive text, for example "Krylov Solver Options" | |
| mansec | - section of manual pages for options, for example KSP (optional) |
One can add subheadings with PetscOptionsHead().
| -1 | - PetscOptionsInt() etc. just call PetscOptionsGetInt() etc. | |
| 0 | - The GUI objects are created in PetscOptionsInt() etc. and displayed in PetscOptionsEnd() and the options database updated with user changes; PetscOptionsGetInt() etc. are also called. | |
| 1 | - PetscOptionsInt() etc. again call PetscOptionsGetInt() etc. (possibly getting new values), in addition the help message and default values are printed if -help was given. When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1) and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of options available so they need to be redisplayed so the user can change the. Changing PetscOptionsObjects.changedmethod is never currently set. |