This file is indexed.

/usr/include/trilinos/Teko_MultPreconditionerFactory.hpp is in libtrilinos-teko-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
/*
// @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_MultiPreconditionerFactory_hpp__
#define __Teko_MultiPreconditionerFactory_hpp__

#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_Utilities.hpp"
#include "Teko_BlockImplicitLinearOp.hpp"

namespace Teko {

/** Preconditioning factories must supply a 'State' class which
  * is where data specific to the preconditioner construction 
  * is stored. The constructor will be invoked elsewhere.
  */
class MultPrecondState : public Teko::BlockPreconditionerState {
public:
   MultPrecondState() {}

   Teuchos::RCP<BlockPreconditionerState> StateOne_;
   Teuchos::RCP<BlockPreconditionerState> StateTwo_;
};

/** Declaration of a Teko::BlockImplicitLinearOp.
  * BlockImplicitLinearOp's are useful
  * when there is no simple or cheap matrix representation 
  * of something like f(r). This particular class 
  * corresponds to
  *         f(r) = (M2 + M1 - M2 * A * M1) r
  * 
  * which is an application of a multiplicative preconditioner.
  * Notice that when M1 = inv(A) or when M2 = inv(A), we get
  * f(r) = inv(A)*r. 
  *
  * While the above matrix represenation could be used
  * instead of writing an implicit function, it requires
  * an additional matrix-vector product than an efficient
  * implementation. It should be noted (see comments below)
  * that there is an efficient matrix represenation of this
  * f(r). Namely,
  *
  *             f(r) =  [M2 I] [I  -A] [ I]
  *                            [0   I] [ M1]
  *
  * so we didn't really need to create an implicit operator.
  */
class MultPrecsLinearOp : public Teko::BlockImplicitLinearOp {
public:

   //! Constructor
   MultPrecsLinearOp(const Teko::LinearOp &A, const Teko::LinearOp &M1, 
            const Teko::LinearOp &M2): A_(A), M1_(M1), M2_(M2) { }

   virtual Teko::VectorSpace  range() const { return M1_->range(); }
   virtual Teko::VectorSpace domain() const { return M1_->domain();}
   virtual void implicitApply(const Teko::BlockedMultiVector & r, Teko::BlockedMultiVector & y,
             const double alpha = 1.0, const double beta = 0.0) const;

protected:
   using Teko::BlockImplicitLinearOp::implicitApply;

   Teko::LinearOp A_, M1_, M2_;

private:
   // hide me!
   MultPrecsLinearOp();
   MultPrecsLinearOp(const MultPrecsLinearOp &);
};

/** Declaration of preconditioner factory that creates
  * a preconditioner which is the multiplicative combination
  * of two other preconditioners.
  */
class MultPreconditionerFactory
   : public Teko::BlockPreconditionerFactory {
public:
   //! Constructor
   MultPreconditionerFactory(const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & FirstFactory,
                             const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & SecondFactory);

   MultPreconditionerFactory();

   //! Function inherited from Teko::BlockPreconditionerFactory
   Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp & blo,
                                            Teko::BlockPreconditionerState & state) const;
    
   //! Build the MultPrecondState object
   virtual Teuchos::RCP<Teko::PreconditionerState> buildPreconditionerState() const;

protected:
   using Teko::BlockPreconditionerFactory::buildPreconditionerOperator;

   // class members
   Teuchos::RCP<const Teko::BlockPreconditionerFactory> FirstFactory_;
   Teuchos::RCP<const Teko::BlockPreconditionerFactory> SecondFactory_;
   
   //! Initialize from a parameter list
   virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
};

} // end namespace Teko

#endif