This file is indexed.

/usr/include/trilinos/Teko_TpetraBlockedMappingStrategy.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
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
/*
// @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_TpetraBlockedMappingStrategy_hpp__
#define __Teko_TpetraBlockedMappingStrategy_hpp__

// stl includes
#include <vector>

// Teuchos includes
#include "Teuchos_RCP.hpp"

// Thyra includes
#include "Thyra_MultiVectorBase.hpp"
#include "Thyra_LinearOpBase.hpp"
#include "Thyra_BlockedLinearOpBase.hpp"

// Tpetra includes
#include "Tpetra_Map.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Import.hpp"
#include "Tpetra_Export.hpp"
#include "Tpetra_CrsMatrix.hpp"

// Teko includes
#include "Teko_TpetraOperatorWrapper.hpp"
#include "Teko_BlockingTpetra.hpp"
#include "Teko_ConfigDefs.hpp"

namespace Teko {
namespace TpetraHelpers {

class TpetraBlockedMappingStrategy : public MappingStrategy {
public:
   //! \name Constructors
   //@{

   /** Creates a strided mapping strategy. This class is useful
     * for breaking up nodally ordered matrices (i.e. the unknowns
     * in a FEM problem are ordered [u0,v0,p0,u1,v1,p1,...]). Current
     * implimentation only supports a fixed number of variables
     *
     * \param[in]      vars   Vector describing the blocking of variables
     * \param[in]      baseMap    original Tpetra::Map<LO,GO,NT>  to be broken up
     * \param[in]      comm   Teuchos::RCP<Teuchos::Comm<int> > object related to the map
     */
   TpetraBlockedMappingStrategy(const std::vector<std::vector<GO> > & vars,
         const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);
   //@}

   //!\name Member functions inherited from Teko::Tpetra::MappingStrategy
   //@{

   /** Virtual function defined in MappingStrategy.  This copies
     * an Tpetra::MultiVector<ST,LO,GO,NT> into a Thyra::MultiVectorBase with
     * blocking handled by the strides defined in the constructor.
     *
     * \param[in]     tpetra_X  source Tpetra::MultiVector<ST,LO,GO,NT>
     * \param[in,out]     thyra_X   destination Thyra::MultiVectorBase
     */
   virtual void copyTpetraIntoThyra(const Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_X, 
                                    const Teuchos::Ptr<Thyra::MultiVectorBase<ST> > & thyra_X) const;

   /** Virtual function defined in MappingStrategy.  This copies
     * an Tpetra::MultiVector<ST,LO,GO,NT> into a Thyra::MultiVectorBase with
     * blocking handled by the strides defined in the constructor.
     *
     * \param[in]     thyra_Y  source Thyra::MultiVectorBase
     * \param[in,out]     tpetra_Y destination Tpetra::MultiVector<ST,LO,GO,NT>
     */
   virtual void copyThyraIntoTpetra(const Teuchos::RCP<const Thyra::MultiVectorBase<ST> > & thyra_Y, 
                                    Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_Y) const;

   /** Returns the domain and range maps used by this class.
     * This faciliates building an Tpetra_Operator around this
     * class with its core functionality being a Thyra::LinearOpBase
     * operator
     *
     * \returns Range map corresponding to this class
     */
   virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap() const
   { return domainMap_; }

   /** Returns the domain and range maps used by this class.
     * This faciliates building an Tpetra_Operator around this
     * class with its core functionality being a Thyra::LinearOpBase
     * operator
     *
     * \returns Range map corresponding to this class
     */
   virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap() const
   { return rangeMap_; }

   /** A function for my sanity
     *
     * \returns String with description of this class
     */
   virtual std::string toString() const
   { return std::string("TpetraBlockedMappingStrategy"); }
 
   //@}

   //! \name Locally useful functions
   //@{

   /** \brief This is the core routine that builds the maps
     * and importers/exporters.
     *
     * This is the core routine that builds the maps
     * and importers/exporters neccessary for all the
     * transfers. Currently it simply calls out to the
     * interlaced tpetra functions. (Comment: this
     * routine should probably be private or protected
     * ... it is basically the meat of the constructor)
     *
     * \param[in]      vars      Vector describing the blocking of variables
     * \param[in]      baseMap   basic map to use in the transfers
     * \param[in]      comm      Teuchos::RCP<Teuchos::Comm<int> > object
     */
   void buildBlockTransferData(const std::vector<std::vector<GO> > & vars,
         const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);

   /** \brief  Get the individual block maps underlying that
     * make up a strided vector/operator.
     *
     * Get the individual block maps underlying that
     * make up a strided vector/operator. These are
     * useful if you want to tear something ... i.e.
     * a matrix ... apart.
     *
     * \returns Return a vector of block maps 
     *             created for this strided operator 
     */
   const std::vector<Blocking::MapPair> & getMaps() const
   { return blockMaps_; }

   /** Builds a blocked Thyra operator that uses the strided
     * mapping strategy to define sub blocks.
     *
     * \param[in] mat Tpetra::CrsMatrix<ST,LO,GO,NT>  with FillComplete called, this
     *             matrix is assumed to be square, with the same
     *             range and domain maps
     * \param[in] label String to be used to prefix the sub block's labels
     *
     * \returns Blocked Thyra linear operator with sub blocks
     *          defined by this mapping strategy
     */
   const Teuchos::RCP<Thyra::BlockedLinearOpBase<ST> > 
   buildBlockedThyraOp(const Teuchos::RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,const std::string & label="<ANYM>") const;

   /** Rebuilds a block Thyra operator using the strided mapping
     * strategy to define sub blocks.
     *
     * \param[in] mat Tpetra::CrsMatrix<ST,LO,GO,NT>  with FillComplete called, this
     *             matrix is assumed to be square, with the same
     *             range and domain maps
     * \param[in] A Destination block linear op composed of blocks of
     *            Tpetra::CrsMatrix<ST,LO,GO,NT>  at all relevant locations
     */
   void rebuildBlockedThyraOp(const RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,
                              const RCP<Thyra::BlockedLinearOpBase<ST> > & A) const;

   //@}

protected:
   // member variables

   //! \name storage for sanity
   //@{
   Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap_; 
   Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap_;
   //@}

   //! \name block transfer data
   //@{
   std::vector<Blocking::MapPair> blockMaps_;
   std::vector<Teuchos::RCP<Tpetra::Import<LO,GO,NT> > > blockImport_;
   std::vector<Teuchos::RCP<Tpetra::Export<LO,GO,NT> > > blockExport_;
   //@}
};

} // end namespace TpetraHelpers
} // end namespace Teko

#endif