mfem::IterativeSolver::PrintLevel Struct Reference

Settings for the output behavior of the IterativeSolver. More...

#include <solvers.hpp>

Public Member Functions
	PrintLevel ()=default
	Initializes the print level to suppress.
Builder
These methods are utilized to construct PrintLevel objects through a builder approach by chaining the function calls in this group.
PrintLevel &	None ()
PrintLevel &	Warnings ()
PrintLevel &	Errors ()
PrintLevel &	Iterations ()
PrintLevel &	FirstAndLast ()
PrintLevel &	Summary ()
PrintLevel &	All ()

Public Attributes
bool	errors = false
	If a fatal problem has been detected the failure will be reported to mfem::err.
bool	warnings = false
	If a non-fatal problem has been detected some context-specific information will be reported to mfem::out.
bool	iterations = false
	Detailed information about each iteration will be reported to mfem::out.
bool	summary = false
	A summary of the solver process will be reported after the last iteration to mfem::out.
bool	first_and_last = false
	Information about the first and last iteration will be printed to mfem::out.

Detailed Description

Settings for the output behavior of the IterativeSolver.

By default, all output is suppressed. The construction of the desired print level can be achieved through a builder pattern, for example

PrintLevel().Errors().Warnings()

constructs the print level with only errors and warnings enabled.

Definition at line 78 of file solvers.hpp.

Constructor & Destructor Documentation

PrintLevel()

mfem::IterativeSolver::PrintLevel::PrintLevel ( )

default

Initializes the print level to suppress.

Member Function Documentation

All()

PrintLevel & mfem::IterativeSolver::PrintLevel::All ( )

inline

Definition at line 109 of file solvers.hpp.

Errors()

PrintLevel & mfem::IterativeSolver::PrintLevel::Errors ( )

inline

Definition at line 105 of file solvers.hpp.

FirstAndLast()

PrintLevel & mfem::IterativeSolver::PrintLevel::FirstAndLast ( )

inline

Definition at line 107 of file solvers.hpp.

Iterations()

PrintLevel & mfem::IterativeSolver::PrintLevel::Iterations ( )

inline

Definition at line 106 of file solvers.hpp.

None()

PrintLevel & mfem::IterativeSolver::PrintLevel::None ( )

inline

Definition at line 103 of file solvers.hpp.

Summary()

PrintLevel & mfem::IterativeSolver::PrintLevel::Summary ( )

inline

Definition at line 108 of file solvers.hpp.

Warnings()

PrintLevel & mfem::IterativeSolver::PrintLevel::Warnings ( )

inline

Definition at line 104 of file solvers.hpp.

Member Data Documentation

errors

bool mfem::IterativeSolver::PrintLevel::errors = false

If a fatal problem has been detected the failure will be reported to mfem::err.

Definition at line 82 of file solvers.hpp.

first_and_last

bool mfem::IterativeSolver::PrintLevel::first_and_last = false

Information about the first and last iteration will be printed to mfem::out.

Definition at line 94 of file solvers.hpp.

iterations

bool mfem::IterativeSolver::PrintLevel::iterations = false

Detailed information about each iteration will be reported to mfem::out.

Definition at line 88 of file solvers.hpp.

summary

bool mfem::IterativeSolver::PrintLevel::summary = false

A summary of the solver process will be reported after the last iteration to mfem::out.

Definition at line 91 of file solvers.hpp.

warnings

bool mfem::IterativeSolver::PrintLevel::warnings = false

If a non-fatal problem has been detected some context-specific information will be reported to mfem::out.

Definition at line 85 of file solvers.hpp.

---

The documentation for this struct was generated from the following file:

• linalg/solvers.hpp