Belos
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
BelosStatusTestOutput.hpp
Go to the documentation of this file.
1
// @HEADER
2
// *****************************************************************************
3
// Belos: Block Linear Solvers Package
4
//
5
// Copyright 2004-2016 NTESS and the Belos contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
// @HEADER
9
//
10
11
#ifndef BELOS_STATUS_TEST_OUTPUT_HPP
12
#define BELOS_STATUS_TEST_OUTPUT_HPP
13
18
19
#include "
BelosConfigDefs.hpp
"
20
#include "
BelosTypes.hpp
"
21
#include "
BelosIteration.hpp
"
22
23
#include "
BelosStatusTest.hpp
"
24
#include "
BelosOutputManager.hpp
"
25
26
27
namespace
Belos
{
28
39
template
<
class
ScalarType,
class
MV,
class
OP>
40
class
StatusTestOutput
:
public
virtual
StatusTest
<ScalarType,MV,OP> {
41
42
public
:
44
45
47
StatusTestOutput
() {}
48
63
StatusTestOutput
(
const
Teuchos::RCP<
OutputManager<ScalarType>
> &printer,
64
Teuchos::RCP<
StatusTest<ScalarType,MV,OP>
> test,
65
int
mod = 1,
66
int
printStates =
Passed
)
67
{}
68
70
virtual
~StatusTestOutput
() {}
72
74
75
78
virtual
void
setOutputManager
(
const
Teuchos::RCP<
OutputManager<ScalarType>
> &printer) = 0;
79
82
virtual
void
setOutputFrequency
(
int
mod) = 0;
83
88
virtual
void
setChild
(Teuchos::RCP<
StatusTest<ScalarType,MV,OP>
> test) = 0;
89
91
virtual
Teuchos::RCP<StatusTest<ScalarType,MV,OP> >
getChild
()
const
= 0;
92
95
virtual
void
setSolverDesc
(
const
std::string& solverDesc) = 0;
96
99
virtual
void
setPrecondDesc
(
const
std::string& precondDesc) = 0;
100
102
103
105
106
108
virtual
void
resetNumCalls
() = 0;
109
111
112
};
113
114
}
// end of Belos namespace
115
116
#endif
/* BELOS_STATUS_TEST_OUTPUT_HPP */
BelosConfigDefs.hpp
Belos header file which uses auto-configuration information to include necessary C++ headers.
BelosIteration.hpp
Pure virtual base class which describes the basic interface to the linear solver iteration.
BelosOutputManager.hpp
Class which manages the output and verbosity of the Belos solvers.
BelosStatusTest.hpp
Pure virtual base class for defining the status testing capabilities of Belos.
BelosTypes.hpp
Collection of types and exceptions used within the Belos solvers.
Belos::OutputManager
Belos's basic output manager for sending information of select verbosity levels to the appropriate ou...
Definition
BelosOutputManager.hpp:42
Belos::StatusTest::StatusTest
StatusTest()
Constructor.
Definition
BelosStatusTest.hpp:57
Belos::StatusTestOutput::StatusTestOutput
StatusTestOutput()
Default constructor.
Definition
BelosStatusTestOutput.hpp:47
Belos::StatusTestOutput::setOutputManager
virtual void setOutputManager(const Teuchos::RCP< OutputManager< ScalarType > > &printer)=0
Set the output manager.
Belos::StatusTestOutput::~StatusTestOutput
virtual ~StatusTestOutput()
Destructor.
Definition
BelosStatusTestOutput.hpp:70
Belos::StatusTestOutput::resetNumCalls
virtual void resetNumCalls()=0
Informs the outputting status test that it should reset the number of calls to zero.
Belos::StatusTestOutput::setPrecondDesc
virtual void setPrecondDesc(const std::string &precondDesc)=0
Set a short preconditioner description for output clarity.
Belos::StatusTestOutput::setChild
virtual void setChild(Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)=0
Set child test.
Belos::StatusTestOutput::setSolverDesc
virtual void setSolverDesc(const std::string &solverDesc)=0
Set a short solver description for output clarity.
Belos::StatusTestOutput::getChild
virtual Teuchos::RCP< StatusTest< ScalarType, MV, OP > > getChild() const =0
Get child test.
Belos::StatusTestOutput::StatusTestOutput
StatusTestOutput(const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
Constructor.
Definition
BelosStatusTestOutput.hpp:63
Belos::StatusTestOutput::setOutputFrequency
virtual void setOutputFrequency(int mod)=0
Set how often the child test is printed.
Belos
Definition
Belos_Details_EBelosSolverType.cpp:13
Belos::Passed
@ Passed
Definition
BelosTypes.hpp:157
Generated for Belos by
1.17.0