Ifpack2::Details::Behavior Class Reference

Description of Ifpack2's behavior. More...

#include <Ifpack2_Details_Behavior.hpp>

Static Public Member Functions
static bool	debug ()
	Whether Ifpack2 is in debug mode.
static bool	writeAdditiveSchwarzLocalMatrix ()
	Whether to write the AdditiveSchwarz local matrix.

Detailed Description

Description of Ifpack2's behavior.

"Behavior" means things like whether to do extra debug checks or print debug output. These depend both on build options and on environment variables. Build options generally control the default behavior.

This class' methods have the following properties:

• They may read the environment.
• They read the environment at most once, on first call.
• They are idempotent.
• They are reentrant.

We intend for it to be inexpensive to call this class' methods repeatedly. The idea is that callers need not cache the results; they may simply call the functions freely.

Ifpack2 does not promise to see changes to environment variables made after first use of this class. Best practice is to set any desired environment variables before starting the executable.

Currently, this class supports the following environment variable:

IFPACK2_DEBUG: flags Ifpack2 to turn on debug checking and debug output.

The environment variable is understood to be "on" or "off", for example:

IFPACK2_DEBUG=ON IFPACK2_DEBUG=OFF

The default value of IFPACK2_DEBUG is ON if Ifpack2 is configured with HAVE_IFPACK2_DEBUG, otherwise it is OFF.

Member Function Documentation

debug()

bool Ifpack2::Details::Behavior::debug ( )

static

Whether Ifpack2 is in debug mode.

"Debug mode" means that Ifpack2 may do extra error checks and may produce more detailed error messages or debug output.

writeAdditiveSchwarzLocalMatrix()

bool Ifpack2::Details::Behavior::writeAdditiveSchwarzLocalMatrix ( )

static

Whether to write the AdditiveSchwarz local matrix.

This is intended for debugging and inspection. You may control this at run time via the IFPACK2_WRITE_ADDITIVE_SCHWARZ_LOCAL_MATRIX environment variable.

---

The documentation for this class was generated from the following files:

• Ifpack2_Details_Behavior.hpp
• Ifpack2_Details_Behavior.cpp