Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
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 
48 
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 
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 */
Collection of types and exceptions used within the Belos solvers.
Belos&#39;s basic output manager for sending information of select verbosity levels to the appropriate ou...
virtual void setSolverDesc(const std::string &solverDesc)=0
Set a short solver description for output clarity.
Class which manages the output and verbosity of the Belos solvers.
virtual void setPrecondDesc(const std::string &precondDesc)=0
Set a short preconditioner description for output clarity.
virtual Teuchos::RCP< StatusTest< ScalarType, MV, OP > > getChild() const =0
Get child test.
Pure virtual base class for defining the status testing capabilities of Belos.
StatusTestOutput()
Default constructor.
StatusTestOutput(const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
Constructor.
Pure virtual base class which describes the basic interface to the linear solver iteration.
A pure virtual class for defining the status tests for the Belos iterative solvers.
virtual void setOutputManager(const Teuchos::RCP< OutputManager< ScalarType > > &printer)=0
Set the output manager.
virtual void setChild(Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)=0
Set child test.
virtual ~StatusTestOutput()
Destructor.
virtual void setOutputFrequency(int mod)=0
Set how often the child test is printed.
Belos header file which uses auto-configuration information to include necessary C++ headers...
A virtual base class for StatusTest that print other status tests.
virtual void resetNumCalls()=0
Informs the outputting status test that it should reset the number of calls to zero.

Generated on Mon Jul 15 2024 09:24:24 for Belos by doxygen 1.8.5