/usr/include/trilinos/BelosIteration.hpp is in libtrilinos-belos-dev 12.12.1-5.
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 137 138 139 140 141 142 143 144 145 146 147 148 | //@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_ITERATION_HPP
#define BELOS_ITERATION_HPP
/*! \file BelosIteration.hpp
\brief Pure virtual base class which describes the basic interface to the linear solver iteration.
*/
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"
namespace Belos {
template <class ScalarType, class MV, class OP>
class LinearProblem;
template <class ScalarType>
class OutputManager;
template <class ScalarType, class MV, class OP>
class StatusTest;
template <class ScalarType, class MV, class OP>
class MatOrthoManager;
template<class ScalarType, class MV, class OP>
class Iteration {
public:
//! @name Constructors/Destructor
//@{
//! Default Constructor.
Iteration() {};
//! Destructor.
virtual ~Iteration() {};
//@}
//! @name Solver methods
//@{
/*! \brief This method performs linear solver iterations until the status test
indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
*/
virtual void iterate() = 0;
/*! \brief Initialize the solver with the initial vectors from the linear problem
* or random data.
*/
virtual void initialize() = 0;
//@}
//! @name Status methods
//@{
//! \brief Get the current iteration count.
virtual int getNumIters() const = 0;
//! \brief Reset the iteration count to iter.
virtual void resetNumIters( int iter = 0 ) = 0;
//! Get the residuals native to the solver.
//! \return A multivector with blockSize vectors containing the native residuals, else the native residual norm is returned.
virtual Teuchos::RCP<const MV> getNativeResiduals( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> *norms ) const = 0;
//! Get the current update to the linear system.
/*! \note Some solvers, like GMRES, do not compute updates to the solution every iteration.
This method forces the computation of the current update.
*/
virtual Teuchos::RCP<MV> getCurrentUpdate() const = 0;
//@}
//! @name Accessor methods
//@{
//! Get a constant reference to the linear problem.
virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;
//! Get the blocksize to be used by the iterative solver in solving this linear problem.
virtual int getBlockSize() const = 0;
//! \brief Set the blocksize to be used by the iterative solver in solving this linear problem.
virtual void setBlockSize(int blockSize) = 0;
//! States whether the solver has been initialized or not.
virtual bool isInitialized() = 0;
//@}
};
} // end Belos namespace
#endif /* BELOS_ITERATION_HPP */
|