PetscOptionsHasHelp#

Determines whether help output has been requested with the “-help” option.

Synopsis#

#include "petscsys.h"   
PetscErrorCode PetscOptionsHasHelp(PetscOptions options, PetscBool *set)

Not Collective

Input Parameter#

options - options database, use NULL for default global database

Output Parameter#

set - PETSC_TRUE if requested else PETSC_FALSE.

Note#

-help accepts a logical value, so this returns PETSC_FALSE for -help 0, -help no, -help false and -help off even though “-help” is then in the database. It returns PETSC_TRUE for -help mansec, which restricts rather than suppresses the help output.

Level#

advanced

Location#

src/sys/objects/options.c

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages