This file is indexed.

/usr/include/trilinos/BelosFixedPointIteration.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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
//@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_FIXEDPOINT_ITERATION_HPP
#define BELOS_FIXEDPOINT_ITERATION_HPP

/*! \file BelosFixedPointIteration.hpp
    \brief Pure virtual base class which augments the basic interface for a fixed point linear solver iteration.
*/

#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosIteration.hpp"

namespace Belos {

  //! @name FixedPointIteration Structures 
  //@{ 
  
  /** \brief Structure to contain pointers to FixedPointIteration state variables.
   *
   * This struct is utilized by FixedPointIteration::initialize() and FixedPointIteration::getState().
   */
  template <class ScalarType, class MV>
  struct FixedPointIterationState {

    /*! \brief The current residual. */
    Teuchos::RCP<const MV> R;

    /*! \brief The current preconditioned residual. */
    Teuchos::RCP<const MV> Z;
    
    FixedPointIterationState() : R(Teuchos::null), Z(Teuchos::null)
    {}
  };

  //! @name FixedPointIteration Exceptions
  //@{ 
  
  /** \brief FixedPointIterationInitFailure is thrown when the FixedPointIteration object is unable to
   * generate an initial iterate in the FixedPointIteration::initialize() routine. 
   *
   * This std::exception is thrown from the FixedPointIteration::initialize() method, which is
   * called by the user or from the FixedPointIteration::iterate() method if isInitialized()
   * == \c false.
   *
   * In the case that this std::exception is thrown, 
   * FixedPointIteration::isInitialized() will be \c false and the user will need to provide
   * a new initial iterate to the iteration.
   */
  class FixedPointIterationInitFailure : public BelosError {public:
    FixedPointIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
    {}};

  /** \brief FixedPointIterateFailure is thrown when the FixedPointIteration object is unable to
   * compute the next iterate in the FixedPointIteration::iterate() routine. 
   *
   * This std::exception is thrown from the FixedPointIteration::iterate() method.
   *
   */
  class FixedPointIterateFailure : public BelosError {public:
    FixedPointIterateFailure(const std::string& what_arg) : BelosError(what_arg)
    {}};
  
  /** \brief FixedPointIterationOrthoFailure is thrown when the FixedPointIteration object is unable to
   * compute independent direction vectors in the FixedPointIteration::iterate() routine. 
   *
   * This std::exception is thrown from the FixedPointIteration::iterate() method.
   *
   */
  class FixedPointIterationOrthoFailure : public BelosError {public:
    FixedPointIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
    {}};

  /** \brief FixedPointIterationLAPACKFailure is thrown when a nonzero return value is passed back
   * from an LAPACK routine.
   *
   * This std::exception is thrown from the FixedPointIteration::iterate() method.
   *
   */
  class FixedPointIterationLAPACKFailure : public BelosError {public:
    FixedPointIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
    {}};
  
  //@}


template<class ScalarType, class MV, class OP>
class FixedPointIteration : virtual public Iteration<ScalarType,MV,OP> {

  public:

  //! @name State methods
  //@{ 
  /*! \brief Initialize the solver to an iterate, providing a complete state.
   *
   * The %FixedPointIteration contains a certain amount of state.
   *
   * initialize() gives the user the opportunity to manually set these,
   * although only the current unpreconditioned residual is required.
   *
   * \post 
   * <li>isInitialized() == \c true (see post-conditions of isInitialize())
   *
   * \note For any pointer in \c newstate which directly points to the multivectors in 
   * the solver, the data is not copied.
   */
  virtual void initializeFixedPoint(FixedPointIterationState<ScalarType,MV>& newstate) = 0;

  /*! \brief Get the current state of the linear solver.
   *
   * The data is only valid if isInitialized() == \c true.
   *
   * \returns A FixedPointIterationState object containing const pointers to the current solver state.
   */
  virtual FixedPointIterationState<ScalarType,MV> getState() const = 0;
  //@}

};

} // end Belos namespace

#endif /* BELOS_FIXEDPOINT_ITERATION_HPP */