Skip to main content
Ctrl+K
Logo image Logo image

Site Navigation

  • Overview
  • Install
  • User-Guide
  • API-Docs
  • Tutorials
  • FAQ
  • Community
  • Developers
  • Misc.

Site Navigation

  • Overview
  • Install
  • User-Guide
  • API-Docs
  • Tutorials
  • FAQ
  • Community
  • Developers
  • Misc.

Section Navigation

  • Changes for each release
  • Single Index of all PETSc Manual Pages

PetscOptionsValidKey#

PETSc Options database keys must begin with one or two dashes (-) followed by a letter.

Synopsis#

#include "petscsys.h"   
PetscErrorCode PetscOptionsValidKey(const char key[], PetscBool *valid)

Not collective

Input Parameter#

  • key - string to check if valid

Output Parameter#

  • valid - PETSC_TRUE if a valid key

Level#

intermediate

Location#

src/sys/objects/options.c


Edit on GitLab

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

previous

PetscOptionsUsed

next

PetscOptionsView

On this page
  • Synopsis
  • Input Parameter
  • Output Parameter
  • Level
  • Location
Edit this page
Show Source

© Copyright 1991-2023, UChicago Argonne, LLC and the PETSc Development Team.

Created using Sphinx 5.3.0.

Last updated on 2023-03-30T10:44:47-0500 (v3.18.6).