PetscOptionsEnd#

Ends a set of queries on the options database that are related and should be displayed on the same window of a GUI that allows the user to set the options interactively.

Synopsis#

#include <petscoptions.h>
PetscErrorCode PetscOptionsEnd(void)

Collective on the comm used in PetscOptionsBegin() or obj used in PetscObjectOptionsBegin()

Notes#

Needs to be preceded by a call to PetscOptionsBegin() or PetscObjectOptionsBegin()

This is a macro that handles its own error checking, it does not return an error code.

Fortran Note#

Returns ierr error code as the final argument per PETSc Fortran API

See Also#

PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsHeadBegin(), PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()

Level#

intermediate

Location#

include/petscoptions.h

Examples#

src/sys/tutorials/ex21.c
src/sys/tutorials/ex9f.F90
src/sys/classes/random/tests/ex3.c
src/sys/objects/device/tests/ex11.cxx
src/sys/tests/ex14.c
src/sys/tests/ex20.c
src/sys/tests/ex61.c
src/sys/tests/ex68.c
src/dm/dt/dualspace/impls/lagrange/tutorials/ex1.c
src/dm/dt/dualspace/impls/lagrange/tutorials/ex2.c


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