/usr/include/trilinos/Amesos2_MultiVecAdapter_decl.hpp is in libtrilinos-amesos2-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 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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | // @HEADER
//
// ***********************************************************************
//
// Amesos2: Templated Direct Sparse Solver Package
// Copyright 2011 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
/**
\file Amesos2_MultiVecAdapter.hpp
\author Eric T Bavier <etbavier@sandia.gov>
\date Wed Feb 10 14:53:29 2010
\brief A templated adapter/wrapper class for Trilinos Multivector
type classes. Provides the functions necessary for Amesos2
to function. Other wrapper methods may of course be added
for special cases.
*/
#ifndef AMESOS2_MULTIVEC_ADAPTER_DECL_HPP
#define AMESOS2_MULTIVEC_ADAPTER_DECL_HPP
#include <Teuchos_RCP.hpp>
#include <Teuchos_Ptr.hpp>
#include <Teuchos_ArrayView.hpp>
#include <Tpetra_Map.hpp>
#include "Amesos2_TypeDecl.hpp"
#include "Amesos2_VectorTraits.hpp"
namespace Amesos2 {
/**
* \brief A templated MultiVector class adapter for Amesos2
*
* Specializations of this templated class provide a unified interface
* to MultiVector types for Amesos2. Any specializations are expected to
* implement the following methods:
*
* <br>
* <b>Implementation Requirements:</b>
* <ul>
* <li>Wrapper constructor
* \code MultiVecAdapter<MultiVecType>(const Teuchos::RCP<MultiVecType>& mat); \endcode
* </li>
*
* <li> Method to get locality of multivec, either globally or locally indexed.
*
* \code
* bool isLocallyIndexed() const;
* bool isGloballyIndexed() const;
*
* Teuchos::RCP<Tpetra::Map<LO,GO,Node> > getMap() const;
* \endcode
* </li>
*
* <li> Method to get multi-vector communicator.
*
* \code
* const Teuchos::RCP<const Teuchos::Comm<int> >& getComm() const;
* \endcode
* </li>
*
* <li> Methods to get the local and global length of vectors and number of
* vectors.
*
* \code
* size_t getLocalLength();
*
* size_t getLocalNumVectors();
*
* global_size_type getGlobalLength();
*
* global_size_type getGlobalNumVectors();
* \endcode
* </li>
*
* <li> Get access to multi-vector stride
*
* \code
* size_t getStride() const;
* \endcode
* </li>
*
* <li> Ask whether this multi-vector has constant stride between vectors on
* this node.
*
* \code
* bool isConstantStride() const;
* \endcode
* </li>
*
* <li> Vector access methods.
*
* \code
* Teuchos::RCP<const Tpetra::Vector<Scalar,LO,GO,Node> >
* getVector( size_t j ) const;
*
* Teuchos::RCP<Tpetra::Vector<Scalar,LO,GO,Node> >
* getVectorNonConst( size_t j );
* \endcode
* </li>
*
* <li> Data access methods
*
* \code
* void get1dCopy( const Teuchos::ArrayView<scalar_type>& A, size_t lda) const;
*
* void get2dCopy( Teuchos::ArrayView<const Teuchos::ArrayView<scalar_type> > A ) const;
* \endcode
* </li>
*
* <li> Method to export an array of new values into the global multi-vector.
*
* \code
* template<typename Value_t>
* void globalize( const Teuchos::ArrayView<Value_t>& newVals )
* \endcode
* </li>
*
* <li> Get a description of this adapter.
*
* \code
* std::string description() const;
* \endcode
* </li>
*
* <li> Print the multivec to the \c os output stream.
*
* \code
* void describe(
* Teuchos::FancyOStream& os,
* const Teuchos::EVerbosityLevel verblevel) const;
* \endcode
* </li>
*
* \ingroup amesos2_multivec_adapters
*/
template <class MV>
struct MultiVecAdapter {};
/** \brief Factory creation method for MultiVecAdapters
*
* Developers should favor this method for creating Amesos2
* MultiVector adapters over using the constructors.
*
* \relates MultiVecAdapter
*/
template <class MV>
Teuchos::RCP<MultiVecAdapter<MV> >
createMultiVecAdapter(Teuchos::RCP<MV> mv){
using Teuchos::rcp;
if(mv.is_null()) return Teuchos::null;
return( rcp(new MultiVecAdapter<MV>(mv)) );
}
template <class MV>
Teuchos::RCP<const MultiVecAdapter<MV> >
createConstMultiVecAdapter(Teuchos::RCP<const MV> mv){
using Teuchos::rcp;
using Teuchos::rcp_const_cast;
if(mv.is_null()) return Teuchos::null;
return( rcp(new MultiVecAdapter<MV>(Teuchos::rcp_const_cast<MV,const MV>(mv))).getConst() );
}
///////////////////////////////////////////////////////////
// Utilities for getting and putting data from MultiVecs //
///////////////////////////////////////////////////////////
namespace Util {
/** \internal
*
* \brief Helper struct for getting pointers to the MV
* data - only used when number of vectors = 1
* and single MPI process
*/
template <typename MV, typename V>
struct vector_pointer_helper {
typedef typename VectorTraits<V>::ptr_scalar_type ptr_return_type ;
static ptr_return_type * get_pointer_to_vector ( const Teuchos::Ptr< MV> &mv ) ;
static ptr_return_type * get_pointer_to_vector ( Teuchos::Ptr< MV> &mv ) ;
static ptr_return_type * get_pointer_to_vector ( const Teuchos::Ptr< const MV > &mv ) ;
static ptr_return_type * get_pointer_to_vector ( Teuchos::Ptr< const MV > &mv ) ;
};
/*
* If the multivector scalar type and the desired scalar tpye are
* the same, then we can do a simple straight copy.
*/
template <typename MV>
struct same_type_get_copy {
static void apply(const Teuchos::Ptr<const MV>& mv,
const Teuchos::ArrayView<typename MV::scalar_t>& v,
const size_t ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution );
};
/*
* In the case where the scalar type of the multi-vector and the
* corresponding S type are different, then we need to first get a
* copy of the scalar values, then convert each one into the S
* type before inserting into the vals array.
*/
template <typename MV, typename S>
struct diff_type_get_copy {
static void apply(const Teuchos::Ptr<const MV>& mv,
const Teuchos::ArrayView<S>& v,
const size_t& ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution );
};
/** \internal
*
* \brief Helper class for getting 1-D copies of multivectors
*
* Handles datatype conversion when appropriate.
*/
template <class MV, typename S>
struct get_1d_copy_helper {
static void
do_get (const Teuchos::Ptr<const MV>& mv,
const Teuchos::ArrayView<S>& vals,
const size_t ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution = ROOTED);
static void
do_get (const Teuchos::Ptr<const MV>& mv,
const Teuchos::ArrayView<S>& vals,
const size_t ldx,
EDistribution distribution,
typename MV::global_ordinal_t indexBase = 0);
static void
do_get (const Teuchos::Ptr<const MV>& mv,
const Teuchos::ArrayView<S>& vals,
const size_t ldx);
};
/*
* If the multivector scalar type and the desired scalar tpye are
* the same, then we can do a simple straight copy.
*/
template <typename MV>
struct same_type_data_put {
static void apply(const Teuchos::Ptr<MV>& mv,
const Teuchos::ArrayView<typename MV::scalar_t>& data,
const size_t ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution );
};
/*
* In the case where the scalar type of the multi-vector and the
* corresponding S type are different, then we need to first get a
* copy of the scalar values, then convert each one into the S
* type before inserting into the vals array.
*/
template <typename MV, typename S>
struct diff_type_data_put {
static void apply(const Teuchos::Ptr<MV>& mv,
const Teuchos::ArrayView<S>& data,
const size_t& ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution );
};
/** \internal
*
* \brief Helper class for putting 1-D data arrays into multivectors
*
* Handles dataype conversion when necessary before putting the data.
*/
template <class MV, typename S>
struct put_1d_data_helper {
static void do_put(const Teuchos::Ptr<MV>& mv,
const Teuchos::ArrayView<S>& data,
const size_t ldx,
Teuchos::Ptr<const Tpetra::Map<typename MV::local_ordinal_t, typename MV::global_ordinal_t, typename MV::node_t> > distribution_map,
EDistribution distribution = ROOTED);
static void do_put(const Teuchos::Ptr<MV>& mv,
const Teuchos::ArrayView<S>& data,
const size_t ldx,
EDistribution distribution, typename MV::global_ordinal_t indexBase = 0);
static void do_put(const Teuchos::Ptr<MV>& mv,
const Teuchos::ArrayView<S>& data,
const size_t ldx);
};
}
} // end namespace Amesos2
#include "Amesos2_TpetraMultiVecAdapter_decl.hpp"
#ifdef HAVE_AMESOS2_EPETRA
# include "Amesos2_EpetraMultiVecAdapter_decl.hpp"
#endif
#endif // AMESOS2_MULTIVEC_ADAPTER_DECL_HPP
|