/usr/include/trilinos/Teko_InterlacedTpetra.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 | /*
// @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_InterlacedTpetra_hpp__
#define __Teko_InterlacedTpetra_hpp__
// Teuchos includes
#include "Teuchos_RCP.hpp"
// include basic Tpetra information
#include "Tpetra_Map.hpp"
#include "Tpetra_CrsMatrix.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Vector.hpp"
#include "Tpetra_Export.hpp"
#include "Tpetra_Import.hpp"
#include "Teko_ConfigDefs.hpp"
#include <vector>
namespace Teko {
namespace TpetraHelpers {
namespace Strided {
/** Build maps to make other conversions. This functions build maps assuming
* that there are number of variables and you want to break them all up
* into single blocks.
*
* \param[in] numGlobals The number of global unknowns in the original map
* \param[in] numVars The number of sub maps to build
* \param[in] comm Communicator to use in construction of the maps
* \param[in,out] subMaps The maps for each block of unknowns. This vector
* will be of length <code>numVars</code>. The integer
* in the pair is the number of local variables being
* represented. For this function it will always be 1.
* The map itself will contain the global indices from
* the original problem. This is useful for Export/Import
* operations. The RCP for the map contains another map
* associated with the string "contigMap" based on a
* contiguous unknown numbering.
*
* \note <code> numGlobals % numVars == 0 </code>
*/
void buildSubMaps(GO numGlobals,int numVars,const Teuchos::Comm<int> & comm,
std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps);
/** Build maps to make other conversions. This functions build maps assuming
* that there are number of variables and you want to break them all up
* into blocks with sizes (in the number of varaibles) specified in <code>vars</code>
*
* \param[in] numGlobals The number of global unknowns in the original map
* \param[in] vars Breakdown of each varaible to build.
* \param[in] comm Communicator to use in construction of the maps
* \param[in,out] subMaps The maps for each block of unknowns. This vector
* will be of length <code>vars.size()</code>. The integer
* in the pair is the number of local variables being
* represented (this will be from <code>vars</code>).
* The map itself will contain the global indices from
* the original problem. This is useful for Export/Import
* operations. The RCP for the map contains another map
* associated with the string "contigMap" based on a
* contiguous unknown numbering.
*
* \note <code> numGlobals % sum(vars) == 0 </code>
*/
void buildSubMaps(GO numGlobals,const std::vector<int> & vars,const Teuchos::Comm<int> & comm,
std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps);
/** Build maps to make other conversions. This functions build maps assuming
* that there are number of variables and you want to break them all up
* into blocks with sizes (in the number of varaibles) specified in <code>vars</code>
*
* \param[in] numGlobals The number of global unknowns in the original map
* \param[in] numMyElements Number of nodes in this processor.
* \param[in] minMyGID Minimum global ID on this processor.
* \param[in] vars Breakdown of each varaible to build.
* \param[in] comm Communicator to use in construction of the maps
* \param[in,out] subMaps The maps for each block of unknowns. This vector
* will be of length <code>vars.size()</code>. The integer
* in the pair is the number of local variables being
* represented (this will be from <code>vars</code>).
* The map itself will contain the global indices from
* the original problem. This is useful for Export/Import
* operations. The RCP for the map contains another map
* associated with the string "contigMap" based on a
* contiguous unknown numbering.
*
* \note <code> numGlobals % sum(vars) == 0 </code>
*/
void buildSubMaps(GO numGlobals,LO numMyElements,GO minMyGID,const std::vector<int> & vars,const Teuchos::Comm<int> & comm,
std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps);
/** Build maps to make other conversions. This functions build maps assuming
* that there are number of variables and you want to break them all up
* into blocks with sizes (in the number of varaibles) specified in <code>vars</code>
*
* \param[in] globalMap Parent map that describes the parallel layout of the new
* sub maps.
* \param[in] vars Breakdown of each varaible to build.
* \param[in] comm Communicator to use in construction of the maps
* \param[in,out] subMaps The maps for each block of unknowns. This vector
* will be of length <code>vars.size()</code>. The integer
* in the pair is the number of local variables being
* represented (this will be from <code>vars</code>).
* The map itself will contain the global indices from
* the original problem. This is useful for Export/Import
* operations. The RCP for the map contains another map
* associated with the string "contigMap" based on a
* contiguous unknown numbering.
*
* \note <code> numGlobals % sum(vars) == 0 </code>
*/
void buildSubMaps(const Tpetra::Map<LO,GO,NT> & globalMap,const std::vector<int> & vars,const Teuchos::Comm<int> & comm,
std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps);
// build conversion import and export operators
void buildExportImport(const Tpetra::Map<LO,GO,NT> & baseMap,
const std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps,
std::vector<Teuchos::RCP<Tpetra::Export<LO,GO,NT> > > & subExport,
std::vector<Teuchos::RCP<Tpetra::Import<LO,GO,NT> > > & subImport);
// build a vector of subVectors
void buildSubVectors(const std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps,
std::vector<Teuchos::RCP<Tpetra::MultiVector<ST,LO,GO,NT> > > & subVectors,LO count);
/** Associate a set of multi-vectors with a set of sub maps (this modifies the "extra data"
* of the subVectors to contain info about the maps.
*/
void associateSubVectors(const std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps,
std::vector<Teuchos::RCP<const Tpetra::MultiVector<ST,LO,GO,NT> > > & subVectors);
// build a single subblock Epetra_CrsMatrix
Teuchos::RCP<Tpetra::CrsMatrix<ST,LO,GO,NT> > buildSubBlock(int i,int j,const Teuchos::RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> >& A,
const std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps);
// Rebuild a single subblock of a matrix
void rebuildSubBlock(int i,int j,const Teuchos::RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> >& A,
const std::vector<std::pair<int,Teuchos::RCP<Tpetra::Map<LO,GO,NT> > > > & subMaps,Tpetra::CrsMatrix<ST,LO,GO,NT> & mat);
// copy contents of many subvectors to a single vector
void many2one(Tpetra::MultiVector<ST,LO,GO,NT> & one, const std::vector<Teuchos::RCP<const Tpetra::MultiVector<ST,LO,GO,NT> > > & many,
const std::vector<Teuchos::RCP<Tpetra::Export<LO,GO,NT> > > & subExport);
// copy contents of a single vector to many subvectors
void one2many(std::vector<Teuchos::RCP<Tpetra::MultiVector<ST,LO,GO,NT> > > & many,const Tpetra::MultiVector<ST,LO,GO,NT> & single,
const std::vector<Teuchos::RCP<Tpetra::Import<LO,GO,NT> > > & subImport);
}
} // end namespace TpetraHelpers
} // end namespace Teko
#endif
|