This file is indexed.

/usr/include/trilinos/Teko_EpetraOperatorWrapper.hpp is in libtrilinos-teko-dev 12.4.2-2.

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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/*
// @HEADER
//
// ***********************************************************************
//
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 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 Eric C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

*/

#ifndef __Teko_EpetraOperatorWrapper_hpp__
#define __Teko_EpetraOperatorWrapper_hpp__

#include "Thyra_LinearOpBase.hpp"
#include "Epetra_Map.h"
#include "Epetra_Comm.h"
#include "Epetra_MultiVector.h"
#include "Epetra_Operator.h"

#include <string>


namespace Teko {
namespace Epetra {
  using Teuchos::RCP;

  class EpetraOperatorWrapper;

  /// Abstract Mapping strategy for an EpetraOperatorWrapper
  class MappingStrategy {
  public:
     virtual ~MappingStrategy() {}

     /** \brief Copy an Epetra_MultiVector into a Thyra::MultiVectorBase
       *
       * Copy an Epetra_MultiVector into a Thyra::MultiVectorBase. The exact
       * method for copying is specified by the concrete implementations.
       *
       * \param[in]     epetraX Vector to be copied into the Thyra object
       * \param[in,out] thyraX  Destination Thyra object
       */
     virtual void copyEpetraIntoThyra(const Epetra_MultiVector& epetraX,
                                      const Teuchos::Ptr<Thyra::MultiVectorBase<double> > & thyraX) const = 0;
                                      // const EpetraOperatorWrapper & eow) const = 0;

     /** \brief Copy an Thyra::MultiVectorBase into a Epetra_MultiVector
       *
       * Copy an Thyra::MultiVectorBase into an Epetra_MultiVector. The exact
       * method for copying is specified by the concrete implementations.
       *
       * \param[in]     thyraX  Source Thyra object
       * \param[in,out] epetraX Destination Epetra object
       */
     virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> > & thyraX,
                                      Epetra_MultiVector& epetraX) const = 0;
                                      // const EpetraOperatorWrapper & eow) const = 0;

     /** \brief Domain map for this strategy */
     virtual const RCP<const Epetra_Map> domainMap() const = 0;

     /** \brief Range map for this strategy */
     virtual const RCP<const Epetra_Map> rangeMap() const = 0;

     /** \brief Identifier string */
     virtual std::string toString() const = 0;
  };

  /// Flip a mapping strategy object around to give the "inverse" mapping strategy.
  class InverseMappingStrategy : public MappingStrategy {
  public:
     /** \brief Constructor to build a inverse MappingStrategy from
       * a forward map.
       */
     InverseMappingStrategy(const RCP<const MappingStrategy> & forward)
        : forwardStrategy_(forward)
     { }

     virtual ~InverseMappingStrategy() {}

     virtual void copyEpetraIntoThyra(const Epetra_MultiVector& epetraX,
                                      const Teuchos::Ptr<Thyra::MultiVectorBase<double> > & thyraX) const
                                      // const EpetraOperatorWrapper & eow) const
     { forwardStrategy_->copyEpetraIntoThyra(epetraX,thyraX); }

     virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> > & thyraX,
                                      Epetra_MultiVector& epetraX) const
                                      // const EpetraOperatorWrapper & eow) const
     { forwardStrategy_->copyThyraIntoEpetra(thyraX,epetraX); }

     /** \brief Domain map for this strategy */
     virtual const RCP<const Epetra_Map> domainMap() const
     { return forwardStrategy_->rangeMap(); }

     /** \brief Range map for this strategy */
     virtual const RCP<const Epetra_Map> rangeMap() const
     { return forwardStrategy_->domainMap(); }

     /** \brief Identifier string */
     virtual std::string toString() const
     { return std::string("InverseMapping(")+forwardStrategy_->toString()+std::string(")"); }
  protected:
     /** \brief Forward mapping strategy object */
     const RCP<const MappingStrategy> forwardStrategy_;

  private:
     InverseMappingStrategy();
     InverseMappingStrategy(const InverseMappingStrategy &);
  };

  /// default mapping strategy for the basic EpetraOperatorWrapper
  class DefaultMappingStrategy : public MappingStrategy {
  public:
     /** */
     DefaultMappingStrategy(const RCP<const Thyra::LinearOpBase<double> > & thyraOp,const Epetra_Comm & comm);

     virtual ~DefaultMappingStrategy() {}

     /** \brief Copy an Epetra_MultiVector into a Thyra::MultiVectorBase
       *
       * Copy an Epetra_MultiVector into a Thyra::MultiVectorBase. The exact
       * method for copying is specified by the concrete implementations.
       *
       * \param[in]     epetraX Vector to be copied into the Thyra object
       * \param[in,out] thyraX  Destination Thyra object
       */
     virtual void copyEpetraIntoThyra(const Epetra_MultiVector& epetraX,
                                      const Teuchos::Ptr<Thyra::MultiVectorBase<double> > & thyraX) const;
                                      // const EpetraOperatorWrapper & eow) const;

     /** \brief Copy an Thyra::MultiVectorBase into a Epetra_MultiVector
       *
       * Copy an Thyra::MultiVectorBase into an Epetra_MultiVector. The exact
       * method for copying is specified by the concrete implementations.
       *
       * \param[in]     thyraX  Source Thyra object
       * \param[in,out] epetraX Destination Epetra object
       */
     virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> > & thyraX,
                                      Epetra_MultiVector& epetraX) const;
                                      // const EpetraOperatorWrapper & eow) const;

     /** \brief Domain map for this strategy */
     virtual const RCP<const Epetra_Map> domainMap() const { return domainMap_; }

     /** \brief Range map for this strategy */
     virtual const RCP<const Epetra_Map> rangeMap() const { return rangeMap_; }

     /** \brief Identifier string */
     virtual std::string toString() const
     { return std::string("DefaultMappingStrategy"); }

  protected:
     RCP<const Thyra::VectorSpaceBase<double> > domainSpace_; ///< Domain space object
     RCP<const Thyra::VectorSpaceBase<double> > rangeSpace_; ///< Range space object

     RCP<const Epetra_Map> domainMap_; ///< Pointer to the constructed domain map
     RCP<const Epetra_Map> rangeMap_; ///< Pointer to the constructed range map
  };

  /** \brief
   * Implements the Epetra_Operator interface with a Thyra LinearOperator. This
   * enables the use of absrtact Thyra operators in AztecOO as preconditioners and
   * operators, without being rendered into concrete Epetra matrices. This is my own
   * modified version that was originally in Thyra.
   */
  class EpetraOperatorWrapper : public Epetra_Operator
  {
  public:
    /** */
    EpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<double> > & thyraOp);
    EpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<double> > & thyraOp,
                          const RCP<const MappingStrategy> & mapStrategy);
    EpetraOperatorWrapper(const RCP<const MappingStrategy> & mapStrategy);

    /** */
    virtual ~EpetraOperatorWrapper() {;}

    /** */
    int SetUseTranspose(bool useTranspose) {
      useTranspose_ = useTranspose;
      return 0;
    }

    /** */
    int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const ;

    /** */
    int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const ;

    /** */
    double NormInf() const ;

    /** */
    const char* Label() const {return label_.c_str();}

    /** */
    bool UseTranspose() const {return useTranspose_;}

    /** */
    bool HasNormInf() const {return false;}

    /** */
    const Epetra_Comm & Comm() const {return *comm_;}

    /** */
    const Epetra_Map& OperatorDomainMap() const {return *mapStrategy_->domainMap();}

    /** */
    const Epetra_Map& OperatorRangeMap() const {return *mapStrategy_->rangeMap();}

    //! Return the thyra operator associated with this wrapper
    const RCP<const Thyra::LinearOpBase<double> > getThyraOp() const
    { return thyraOp_; }

    //! Get the mapping strategy for this wrapper (translate between Thyra and Epetra)
    const RCP<const MappingStrategy> getMapStrategy() const
    { return mapStrategy_; }

    //! Get the number of block rows in this operator
    virtual int GetBlockRowCount();

    //! Get the number of block columns in this operator
    virtual int GetBlockColCount();

    //! Grab the i,j block
    Teuchos::RCP<const Epetra_Operator> GetBlock(int i,int j) const;

  protected:
    /** */
    EpetraOperatorWrapper();

    /** */
    RCP<const Epetra_Comm> getEpetraComm(const Thyra::LinearOpBase<double> & inOp) const;

    /** */
    void SetOperator(const RCP<const Thyra::LinearOpBase<double> > & thyraOp,bool buildMap=true);

    /** */
    void SetMapStrategy(const RCP<const MappingStrategy> & mapStrategy)
    { mapStrategy_ = mapStrategy; }

    /** */
    RCP<const MappingStrategy> mapStrategy_;

    /** */
    RCP<const Thyra::LinearOpBase<double> > thyraOp_;

    /** */
    bool useTranspose_;

    /** */
    RCP<const Epetra_Comm> comm_;

    /** */
    std::string label_;
  };
} // end namespace Epetra
} // end namespace Teko

#endif