PetscBool#

Logical variable.

Synopsis#

typedef/*E
   PetscBool3  - Ternary logical variable. Actually an enum in C and a 4 byte integer in Fortran.

   

   Note:
   Should not be used with the if (flg) or if (!flg) syntax.

.seealso: `PETSC_TRUE`, `PETSC_FALSE`, `PetscNot()`, `PETSC_BOOL3_TRUE`, `PETSC_BOOL3_FALSE`, `PETSC_BOOL3_UNKNOWN`
E*/ {
  PETSC_BOOL3_FALSE   = 0,
  PETSC_BOOL3_TRUE    = 1,
  PETSC_BOOL3_UNKNOWN = -1 /* the value is unknown at the time of query, but might be determined later */
} PetscBool3;

Notes#

This is a C bool.

Use MPI_C_BOOL for communicating with MPI calls in C, C++, and Fortran.

Fortran Note#

This is a logical(C_BOOL).

Developer Note#

We should deprecate this definition since there is a native representation in all the languages.

Level#

beginner

Location#

include/petscsystypes.h

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