Belos Version of the Day
Loading...
Searching...
No Matches
BelosStatusTestOutput.hpp
Go to the documentation of this file.
1//@HEADER
2// ************************************************************************
3//
4// Belos: Block Linear Solvers Package
5// Copyright 2004 Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ************************************************************************
40//@HEADER
41//
42
43#ifndef BELOS_STATUS_TEST_OUTPUT_HPP
44#define BELOS_STATUS_TEST_OUTPUT_HPP
45
51#include "BelosConfigDefs.hpp"
52#include "BelosTypes.hpp"
53#include "BelosIteration.hpp"
54
55#include "BelosStatusTest.hpp"
57
58
59namespace Belos {
60
71template <class ScalarType, class MV, class OP>
72class StatusTestOutput : public virtual StatusTest<ScalarType,MV,OP> {
73
74 public:
76
77
80
95 StatusTestOutput(const Teuchos::RCP<OutputManager<ScalarType> > &printer,
96 Teuchos::RCP<StatusTest<ScalarType,MV,OP> > test,
97 int mod = 1,
98 int printStates = Passed)
99 {}
100
102 virtual ~StatusTestOutput() {}
104
106
107
110 virtual void setOutputManager(const Teuchos::RCP<OutputManager<ScalarType> > &printer) = 0;
111
114 virtual void setOutputFrequency(int mod) = 0;
115
120 virtual void setChild(Teuchos::RCP<StatusTest<ScalarType,MV,OP> > test) = 0;
121
123 virtual Teuchos::RCP<StatusTest<ScalarType,MV,OP> > getChild() const = 0;
124
127 virtual void setSolverDesc(const std::string& solverDesc) = 0;
128
131 virtual void setPrecondDesc(const std::string& precondDesc) = 0;
132
134
135
137
138
140 virtual void resetNumCalls() = 0;
141
143
144};
145
146} // end of Belos namespace
147
148#endif /* BELOS_STATUS_TEST_OUTPUT_HPP */
Belos header file which uses auto-configuration information to include necessary C++ headers.
Pure virtual base class which describes the basic interface to the linear solver iteration.
Class which manages the output and verbosity of the Belos solvers.
Pure virtual base class for defining the status testing capabilities of Belos.
Collection of types and exceptions used within the Belos solvers.
Belos's basic output manager for sending information of select verbosity levels to the appropriate ou...
A virtual base class for StatusTest that print other status tests.
StatusTestOutput()
Default constructor.
virtual void setOutputManager(const Teuchos::RCP< OutputManager< ScalarType > > &printer)=0
Set the output manager.
virtual ~StatusTestOutput()
Destructor.
virtual void resetNumCalls()=0
Informs the outputting status test that it should reset the number of calls to zero.
virtual void setPrecondDesc(const std::string &precondDesc)=0
Set a short preconditioner description for output clarity.
virtual void setChild(Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)=0
Set child test.
virtual void setSolverDesc(const std::string &solverDesc)=0
Set a short solver description for output clarity.
virtual Teuchos::RCP< StatusTest< ScalarType, MV, OP > > getChild() const =0
Get child test.
StatusTestOutput(const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
Constructor.
virtual void setOutputFrequency(int mod)=0
Set how often the child test is printed.
A pure virtual class for defining the status tests for the Belos iterative solvers.

Generated for Belos by doxygen 1.9.6