MFEM  v4.5.1
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | List of all members
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. More...
 
Builder

These methods are utilized to construct PrintLevel objects through a builder approach by chaining the function calls in this group.

PrintLevelNone ()
 
PrintLevelWarnings ()
 
PrintLevelErrors ()
 
PrintLevelIterations ()
 
PrintLevelFirstAndLast ()
 
PrintLevelSummary ()
 
PrintLevelAll ()
 

Public Attributes

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

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

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

Initializes the print level to suppress.

Member Function Documentation

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

Definition at line 109 of file solvers.hpp.

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

Definition at line 105 of file solvers.hpp.

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

Definition at line 107 of file solvers.hpp.

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

Definition at line 106 of file solvers.hpp.

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

Definition at line 103 of file solvers.hpp.

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

Definition at line 108 of file solvers.hpp.

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

Definition at line 104 of file solvers.hpp.

Member Data Documentation

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.

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.

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.

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.

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: