/usr/include/trilinos/BelosStatusTestResNorm.hpp is in libtrilinos-belos-dev 12.10.1-3.
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 | //@HEADER
// ************************************************************************
//
// Belos: Block Linear Solvers Package
// Copyright 2004 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
#ifndef BELOS_STATUS_TEST_RESNORM_H
#define BELOS_STATUS_TEST_RESNORM_H
/*!
\file BelosStatusTestResNorm.hpp
\brief Belos::StatusTest abstract class for specifying a residual norm stopping criteria.
*/
#include "BelosStatusTest.hpp"
#include "BelosLinearProblem.hpp"
#include "BelosMultiVecTraits.hpp"
/*!
\class Belos::StatusTestResNorm
\brief An abstract class of StatusTest for stopping criteria using residual norms.
*/
namespace Belos {
template <class ScalarType, class MV, class OP>
class StatusTestResNorm: public StatusTest<ScalarType,MV,OP> {
public:
// Convenience typedefs
typedef Teuchos::ScalarTraits<ScalarType> SCT;
typedef typename SCT::magnitudeType MagnitudeType;
typedef MultiVecTraits<ScalarType,MV> MVT;
//! @name Form and parameter definition methods.
//@{
//! Set the value of the tolerance
/*! We allow the tolerance to be reset for cases where, in the process of testing the residual,
we find that the initial tolerance was too tight or too lax.
*/
virtual int setTolerance(MagnitudeType tolerance) = 0;
//! Sets the number of residuals that must pass the convergence test before Passed is returned.
//! \note If \c quorum=-1 then all residuals must pass the convergence test before Passed is returned.
virtual int setQuorum(int quorum) = 0;
//! Set whether the only maximum residual norm is displayed when the print() method is called
virtual int setShowMaxResNormOnly(bool showMaxResNormOnly) = 0;
//! Define the form of the scaling for the residual.
virtual int defineScaleForm( ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue = Teuchos::ScalarTraits<MagnitudeType>::one()) = 0;
//@}
//! @name Methods to access data members.
//@{
//! Returns the number of residuals that must pass the convergence test before Passed is returned.
//! \note If \c quorum=-1 then all residuals must pass the convergence test before Passed is returned.
virtual int getQuorum() const = 0;
//! Returns whether the only maximum residual norm is displayed when the print() method is called
virtual bool getShowMaxResNormOnly() = 0;
//! Returns the std::vector containing the indices of the residuals that passed the test.
virtual std::vector<int> convIndices() = 0;
//! Returns the value of the tolerance, \f$ \tau \f$, set in the constructor.
virtual MagnitudeType getTolerance() const = 0;
//! Returns the test value, \f$ \frac{\|r\|}{\sigma} \f$, computed in most recent call to CheckStatus.
virtual const std::vector<MagnitudeType>* getTestValue() const = 0;
//! Returns the current solution estimate that was computed for the most recent residual test.
//! \note This method will return a null pointer if no vector was computed.
virtual Teuchos::RCP<MV> getSolution() = 0;
//! Returns a boolean indicating a loss of accuracy has been detected in computing the residual.
virtual bool getLOADetected() const = 0;
//@}
};
} // end namespace Belos
#endif /* BELOS_STATUS_TEST_RESNORM_H */
|