/usr/include/trilinos/BelosStatusTest.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | // @HEADER
// ***********************************************************************
//
// Belos: Block Linear Solvers Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
//
#ifndef BELOS_STATUS_TEST_HPP
#define BELOS_STATUS_TEST_HPP
/*!
\file BelosStatusTest.hpp
\brief Pure virtual base class for defining the status testing capabilities of Belos.
*/
#include "BelosTypes.hpp"
#include "BelosIteration.hpp"
#include "BelosConfigDefs.hpp"
#include "Teuchos_Describable.hpp"
/*!
\class Belos::StatusTest
\brief A pure virtual class for defining the status tests for the Belos iterative solvers
Belos::StatusTest is an interface that can be implemented to create convergence tests for
all Belos solvers. Almost any kind of test can be expressed using this mechanism,
including composite tests (see Belos::StatusTestCombo).
*/
namespace Belos {
//! @name StatusTest Exceptions
//@{
/** \brief Exception thrown to signal error in a status test during Belos::StatusTest::checkStatus().
*/
class StatusTestError : public BelosError
{public: StatusTestError(const std::string& what_arg) : BelosError(what_arg) {}};
//@}
template <class ScalarType, class MV, class OP>
class StatusTest : public Teuchos::Describable {
public:
//! @name Constructors/destructors
//@{
//! Constructor
StatusTest() {};
//! Destructor
virtual ~StatusTest() {};
//@}
//! @name Status methods
//@{
//! Check convergence status: Unconverged, Converged, Failed.
/*! This method checks to see if the convergence criteria are met. The calling routine may pass in the
current native residual std::vector (the one naturally produced as part of the iterative method) or a
pre-computed estimate of the two-norm of the current residual, or both or neither. The calling routine
should also indicate if the solution of the linear problem has been updated to be compatible with
the residual. Some methods, such as GMRES do not update the solution at each iteration.
\return Belos::StatusType: Unconverged, Converged or Failed.
*/
virtual StatusType checkStatus( Iteration<ScalarType,MV,OP>* iSolver ) = 0;
//! Return the result of the most recent CheckStatus call.
virtual StatusType getStatus() const = 0;
//@}
//! @name Reset methods
//@{
//! Informs the convergence test that it should reset its internal configuration to the initialized state.
/*! This is necessary for the case when the status test is being reused by another solver or for another
linear problem. The status test may have information that pertains to a particular linear system. The
internal information will be reset back to the initialized state. The user specified information that
the convergence test uses will remain.
*/
virtual void reset() = 0;
//@}
//! @name Print methods
//@{
//! Output formatted description of stopping test to output stream.
virtual void print(std::ostream& os, int indent = 0) const = 0;
//! Output the result of the most recent CheckStatus call.
virtual void printStatus(std::ostream& os, StatusType type) const {
os << std::left << std::setw(13) << std::setfill('.');
switch (type) {
case Passed:
os << "Passed";
break;
case Failed:
os << "Failed";
break;
case Undefined:
default:
os << "**";
break;
}
os << std::left << std::setfill(' ');
return;
};
//@}
};
} // end of Belos namespace
#endif /* BELOS_STATUS_TEST_HPP */
|