/usr/include/trilinos/Xpetra_EpetraVector.hpp is in libtrilinos-xpetra-dev 12.10.1-3.
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 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 | // @HEADER
//
// ***********************************************************************
//
// Xpetra: A linear algebra interface package
// Copyright 2012 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
// Jonathan Hu (jhu@sandia.gov)
// Andrey Prokopenko (aprokop@sandia.gov)
// Ray Tuminaro (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_EPETRAVECTOR_HPP
#define XPETRA_EPETRAVECTOR_HPP
/* this file is automatically generated - do not edit (see script/epetra.py) */
#include "Xpetra_EpetraConfigDefs.hpp"
#include "Xpetra_Vector.hpp"
#include "Xpetra_EpetraMultiVector.hpp"
#include "Xpetra_EpetraMap.hpp" //TMP
#include "Xpetra_Utils.hpp"
#include "Xpetra_EpetraImport.hpp"
#include "Xpetra_EpetraExport.hpp"
#include "Xpetra_Exceptions.hpp"
#include <Epetra_Vector.h>
namespace Xpetra {
// TODO: move that elsewhere
template<class GlobalOrdinal, class Node>
Epetra_Vector & toEpetra(Vector<double, int, GlobalOrdinal, Node> &);
template<class GlobalOrdinal, class Node>
const Epetra_Vector & toEpetra(const Vector<double, int, GlobalOrdinal, Node> &);
//
template<class EpetraGlobalOrdinal, class Node>
class EpetraVectorT
: public virtual Vector<double,int,EpetraGlobalOrdinal, Node>, public EpetraMultiVectorT<EpetraGlobalOrdinal, Node>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef EpetraGlobalOrdinal GlobalOrdinal;
public:
//! Compute 1-norm of each vector in multi-vector.
void norm1(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { }
//!
void norm2(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { }
//! Compute Inf-norm of each vector in multi-vector.
void normInf(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { }
//! Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).
void meanValue(const Teuchos::ArrayView< Scalar > &means) const { }
//! Replace value, using global (row) index.
void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { }
//! Add value to existing value, using global (row) index.
void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { }
//! Replace value, using local (row) index.
void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { }
//! Add value to existing value, using local (row) index.
void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { }
//! Compute the dot product of each corresponding pair of vectors (columns) in A and B.
void dot(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayView< Scalar > &dots) const { }
//! @name Constructor/Destructor Methods
//@{
//! Sets all vector entries to zero.
explicit EpetraVectorT(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, bool zeroOut=true) : EpetraMultiVectorT<GlobalOrdinal, Node>(map,1,zeroOut) {};
// Commenting out since no definition provided in cpp.
//! Vector copy constructor.
// EpetraVectorT(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source);
//! Destructor.
virtual ~EpetraVectorT() { }
//@}
//! @name Post-construction modification routines
//@{
//! Replace current value at the specified location with specified value.
void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value) {};
//! Adds specified value to existing value at the specified location.
void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value) {};
//! Replace current value at the specified location with specified values.
void replaceLocalValue(LocalOrdinal myRow, const Scalar &value) {};
//! Adds specified value to existing value at the specified location.
void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value) {};
//@}
//! @name Mathematical methods
//@{
//! Computes dot product of this Vector against input Vector x.
Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const { return Teuchos::ScalarTraits<Scalar>::zero(); };
//! Return 1-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const { return Teuchos::ScalarTraits<Scalar>::magnitude(Teuchos::ScalarTraits<Scalar>::zero());};
//! Compute 2-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const {return Teuchos::ScalarTraits<Scalar>::magnitude(Teuchos::ScalarTraits<Scalar>::zero());};
//! Compute Inf-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const {return Teuchos::ScalarTraits<Scalar>::magnitude(Teuchos::ScalarTraits<Scalar>::zero());};
//! Compute Weighted 2-norm (RMS Norm) of this Vector.
//Teuchos::ScalarTraits< Scalar >::magnitudeType normWeighted(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const;
//! Compute mean (average) value of this Vector.
Scalar meanValue() const {return Teuchos::ScalarTraits<Scalar>::zero();};
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! Return a simple one-line description of this object.
std::string description() const { return std::string(""); }
//! Print the object with some verbosity level to an FancyOStream object.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {};
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_Vector object
EpetraVectorT(const Teuchos::RCP<Epetra_Vector> &vec) : EpetraMultiVectorT<GlobalOrdinal, Node>(vec) { // TODO: removed const of Epetra::Vector
TEUCHOS_TEST_FOR_EXCEPTION(true, Xpetra::Exceptions::RuntimeError,
"Xpetra::EpetraVector only available for GO=int or GO=long long with EpetraNode (Serial or OpenMP depending on configuration)");
}
//! Get the underlying Epetra vector
Epetra_Vector * getEpetra_Vector() const { return NULL; /*return (*this->EpetraMultiVectorT<GlobalOrdinal, Node>::getEpetra_MultiVector())(0);*/ }
//RCP<Epetra_Vector> getEpetra_Vector() const { return this->EpetraMultiVectorT<GlobalOrdinal>::getEpetra_MultiVector()->getVectorNonConst(0); }
//! This constructor creates a Vector which is a view of column j of the MultiVector 'mv'.
//! It implements the logic of MultiVector::getVector/getVectorNonConst() for Epetra MultiVector.
//! The newly created Xpetra::EpetraVectorT will remain valid after the disappearance of the references to 'mv' in user code.
EpetraVectorT(const RCP<Epetra_MultiVector> &mv, size_t j) : EpetraMultiVectorT<GlobalOrdinal, Node>(mv) {};
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
typename dual_view_type::t_host_um getHostLocalView () const {
return this->EpetraMultiVectorT<GlobalOrdinal,Node>::getHostLocalView();
}
typename dual_view_type::t_dev_um getDeviceLocalView() const {
throw std::runtime_error("Epetra does not support device views!");
typename dual_view_type::t_dev ret;
return ret; // make compiler happy
}
/// \brief Return an unmanaged non-const view of the local data on a specific device.
/// \tparam TargetDeviceType The Kokkos Device type whose data to return.
///
/// \warning DO NOT USE THIS FUNCTION! There is no reason why you are working directly
/// with the Xpetra::EpetraVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::Vector!
///
/// \warning Be aware that the view on the vector data is non-persisting, i.e.
/// only valid as long as the vector does not run of scope!
template<class TargetDeviceType>
typename Kokkos::Impl::if_c<
Kokkos::Impl::is_same<
typename dual_view_type::t_dev_um::execution_space::memory_space,
typename TargetDeviceType::memory_space>::value,
typename dual_view_type::t_dev_um,
typename dual_view_type::t_host_um>::type
getLocalView () const {
return this->MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::template getLocalView<TargetDeviceType>();
}
#endif
//@}
private:
// This private member is only used by the constructor EpetraVectorT(const RCP<EpetraMultiVectorT<GlobalOrdinal> > &mv, size_t j). The actual private member holding the Epetra vector (vec_) is in the base class (Xpetra:EpetraMultiVectorT)
// TODO remove this...
const RCP<const Epetra_MultiVector> internalRefToBaseMV_;
}; // EpetraVectorT class
// specialization on GO=int and Node=Serial
#ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
template<>
class EpetraVectorT<int, EpetraNode>
: public virtual Vector<double,int,int,EpetraNode>, public EpetraMultiVectorT<int,EpetraNode>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef int GlobalOrdinal;
typedef EpetraNode Node;
public:
using EpetraMultiVectorT<GlobalOrdinal, Node>::dot; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::norm1; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::norm2; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::normInf; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::meanValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::replaceGlobalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::sumIntoGlobalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::replaceLocalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::sumIntoLocalValue; // overloading, not hiding
//! @name Constructor/Destructor Methods
//@{
//! Sets all vector entries to zero.
explicit EpetraVectorT(const Teuchos::RCP<const Map<int,GlobalOrdinal,Node> > &map, bool zeroOut=true) : EpetraMultiVectorT<GlobalOrdinal, Node>(map,1,zeroOut) { }
// Commenting out since no definition provided in cpp.
//! Vector copy constructor.
// EpetraVectorT(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source);
//! Destructor.
virtual ~EpetraVectorT() { }
//@}
//! @name Post-construction modification routines
//@{
//! Replace current value at the specified location with specified value.
void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::replaceGlobalValue"); this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->ReplaceGlobalValue(globalRow, 0, value); }
//! Adds specified value to existing value at the specified location.
void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::sumIntoGlobalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->SumIntoGlobalValue(globalRow, 0, value); }
//! Replace current value at the specified location with specified values.
void replaceLocalValue(LocalOrdinal myRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::replaceLocalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->ReplaceMyValue(myRow, 0, value); }
//! Adds specified value to existing value at the specified location.
void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::sumIntoLocalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->SumIntoMyValue(myRow, 0, value); }
//@}
//! @name Mathematical methods
//@{
//! Computes dot product of this Vector against input Vector x.
Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const {
XPETRA_MONITOR("EpetraVectorT::dot");
XPETRA_DYNAMIC_CAST(const EpetraVectorT, a, tA, "This Xpetra::EpetraVectorT method only accept Xpetra::EpetraVectorT as input arguments.");
// return getEpetra_Vector()->Dot(*tA.getEpetra_Vector());
// other way: use the MultiVector Dot instead of VectorDot:
double r;
this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Epetra_MultiVector::Dot(*tA.getEpetra_MultiVector(), &r);
return r;
}
//! Return 1-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const { XPETRA_MONITOR("EpetraVectorT::norm1"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Norm1(&r); return r; }
//! Compute 2-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const { XPETRA_MONITOR("EpetraVectorT::norm2"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Norm2(&r); return r; }
//! Compute Inf-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const { XPETRA_MONITOR("EpetraVectorT::normInf"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->NormInf(&r); return r; }
//! Compute Weighted 2-norm (RMS Norm) of this Vector.
//Teuchos::ScalarTraits< Scalar >::magnitudeType normWeighted(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const;
//! Compute mean (average) value of this Vector.
Scalar meanValue() const {
XPETRA_MONITOR("EpetraVectorT::meanValue");
Scalar r;
this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->MeanValue(&r);
return r;
}
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! Return a simple one-line description of this object.
std::string description() const {
XPETRA_MONITOR("EpetraVectorT::description");
// This implementation come from Epetra_Vector_def.hpp (without modification)
std::ostringstream oss;
oss << Teuchos::Describable::description();
oss << "{length="<<this->getGlobalLength()
<< "}";
return oss.str();
}
//! Print the object with some verbosity level to an FancyOStream object.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {
XPETRA_MONITOR("EpetraVectorT::describe");
if (verbLevel > Teuchos::VERB_NONE) {
getEpetra_Vector()->Print (out);
}
}
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_Vector object
EpetraVectorT(const Teuchos::RCP<Epetra_Vector> &vec) : EpetraMultiVectorT<GlobalOrdinal, Node>(vec) { } // TODO: removed const of Epetra::Vector
//! Get the underlying Epetra vector
Epetra_Vector * getEpetra_Vector() const { return (*this->EpetraMultiVectorT<GlobalOrdinal, Node>::getEpetra_MultiVector())(0); }
//RCP<Epetra_Vector> getEpetra_Vector() const { return this->EpetraMultiVectorT<GlobalOrdinal>::getEpetra_MultiVector()->getVectorNonConst(0); }
//! This constructor creates a Vector which is a view of column j of the MultiVector 'mv'.
//! It implements the logic of MultiVector::getVector/getVectorNonConst() for Epetra MultiVector.
//! The newly created Xpetra::EpetraVectorT will remain valid after the disappearance of the references to 'mv' in user code.
EpetraVectorT(const RCP<Epetra_MultiVector> &mv, size_t j)
: EpetraMultiVectorT<GlobalOrdinal,Node>(rcp((*mv)(j), false)), // view of the vector number j. false == I do not own the data.
internalRefToBaseMV_(mv) // keep an internal reference to the initial MultiVector to avoid desallocation of the view.
{
// The view of the internal data of 'mv' is only valid until the destruction of 'mv'.
// The new vector hold an internal reference to 'mv' in order to keep the view valid after disappearance of 'mv' references in user code.
// This implements the logic of subArray rcp (as required by the Tpetra interface).
}
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
typename dual_view_type::t_host_um getHostLocalView () const {
return this->EpetraMultiVectorT<GlobalOrdinal,Node>::getHostLocalView();
}
typename dual_view_type::t_dev_um getDeviceLocalView() const {
throw std::runtime_error("Epetra does not support device views!");
typename dual_view_type::t_dev ret;
return ret; // make compiler happy
}
/// \brief Return an unmanaged non-const view of the local data on a specific device.
/// \tparam TargetDeviceType The Kokkos Device type whose data to return.
///
/// \warning DO NOT USE THIS FUNCTION! There is no reason why you are working directly
/// with the Xpetra::EpetraVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::Vector!
///
/// \warning Be aware that the view on the vector data is non-persisting, i.e.
/// only valid as long as the vector does not run of scope!
template<class TargetDeviceType>
typename Kokkos::Impl::if_c<
Kokkos::Impl::is_same<
typename dual_view_type::t_dev_um::execution_space::memory_space,
typename TargetDeviceType::memory_space>::value,
typename dual_view_type::t_dev_um,
typename dual_view_type::t_host_um>::type
getLocalView () const {
return this->MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::template getLocalView<TargetDeviceType>();
}
#endif
//@}
private:
// This private member is only used by the constructor EpetraVectorT(const RCP<EpetraMultiVectorT<GlobalOrdinal> > &mv, size_t j). The actual private member holding the Epetra vector (vec_) is in the base class (Xpetra:EpetraMultiVectorT)
const RCP<const Epetra_MultiVector> internalRefToBaseMV_;
};
#endif
// specialization on GO=long long and Node=Serial
#ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
template<>
class EpetraVectorT<long long, EpetraNode>
: public virtual Vector<double,int,long long,EpetraNode>, public EpetraMultiVectorT<long long,EpetraNode>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef long long GlobalOrdinal;
typedef EpetraNode Node;
public:
using EpetraMultiVectorT<GlobalOrdinal, Node>::dot; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::norm1; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::norm2; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::normInf; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::meanValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::replaceGlobalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::sumIntoGlobalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::replaceLocalValue; // overloading, not hiding
using EpetraMultiVectorT<GlobalOrdinal, Node>::sumIntoLocalValue; // overloading, not hiding
//! @name Constructor/Destructor Methods
//@{
//! Sets all vector entries to zero.
explicit EpetraVectorT(const Teuchos::RCP<const Map<int,GlobalOrdinal,Node> > &map, bool zeroOut=true) : EpetraMultiVectorT<GlobalOrdinal, Node>(map,1,zeroOut) { }
// Commenting out since no definition provided in cpp.
//! Vector copy constructor.
// EpetraVectorT(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source);
//! Destructor.
virtual ~EpetraVectorT() { }
//@}
//! @name Post-construction modification routines
//@{
//! Replace current value at the specified location with specified value.
void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::replaceGlobalValue"); this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->ReplaceGlobalValue(globalRow, 0, value); }
//! Adds specified value to existing value at the specified location.
void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::sumIntoGlobalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->SumIntoGlobalValue(globalRow, 0, value); }
//! Replace current value at the specified location with specified values.
void replaceLocalValue(LocalOrdinal myRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::replaceLocalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->ReplaceMyValue(myRow, 0, value); }
//! Adds specified value to existing value at the specified location.
void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value) { XPETRA_MONITOR("EpetraVectorT::sumIntoLocalValue");this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->SumIntoMyValue(myRow, 0, value); }
//@}
//! @name Mathematical methods
//@{
//! Computes dot product of this Vector against input Vector x.
Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const {
XPETRA_MONITOR("EpetraVectorT::dot");
XPETRA_DYNAMIC_CAST(const EpetraVectorT, a, tA, "This Xpetra::EpetraVectorT method only accept Xpetra::EpetraVectorT as input arguments.");
// return getEpetra_Vector()->Dot(*tA.getEpetra_Vector());
// other way: use the MultiVector Dot instead of VectorDot:
double r;
this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Epetra_MultiVector::Dot(*tA.getEpetra_MultiVector(), &r);
return r;
}
//! Return 1-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const { XPETRA_MONITOR("EpetraVectorT::norm1"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Norm1(&r); return r; }
//! Compute 2-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const { XPETRA_MONITOR("EpetraVectorT::norm2"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->Norm2(&r); return r; }
//! Compute Inf-norm of this Vector.
Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const { XPETRA_MONITOR("EpetraVectorT::normInf"); Scalar r; this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->NormInf(&r); return r; }
//! Compute Weighted 2-norm (RMS Norm) of this Vector.
//Teuchos::ScalarTraits< Scalar >::magnitudeType normWeighted(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const;
//! Compute mean (average) value of this Vector.
Scalar meanValue() const {
XPETRA_MONITOR("EpetraVectorT::meanValue");
Scalar r;
this->EpetraMultiVectorT<GlobalOrdinal,Node>::getEpetra_MultiVector()->MeanValue(&r);
return r;
}
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! Return a simple one-line description of this object.
std::string description() const {
XPETRA_MONITOR("EpetraVectorT::description");
// This implementation come from Epetra_Vector_def.hpp (without modification)
std::ostringstream oss;
oss << Teuchos::Describable::description();
oss << "{length="<<this->getGlobalLength()
<< "}";
return oss.str();
}
//! Print the object with some verbosity level to an FancyOStream object.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {
XPETRA_MONITOR("EpetraVectorT::describe");
if (verbLevel > Teuchos::VERB_NONE) {
getEpetra_Vector()->Print (out);
}
}
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_Vector object
EpetraVectorT(const Teuchos::RCP<Epetra_Vector> &vec) : EpetraMultiVectorT<GlobalOrdinal, Node>(vec) { } // TODO: removed const of Epetra::Vector
//! Get the underlying Epetra vector
Epetra_Vector * getEpetra_Vector() const { return (*this->EpetraMultiVectorT<GlobalOrdinal, Node>::getEpetra_MultiVector())(0); }
//RCP<Epetra_Vector> getEpetra_Vector() const { return this->EpetraMultiVectorT<GlobalOrdinal>::getEpetra_MultiVector()->getVectorNonConst(0); }
//! This constructor creates a Vector which is a view of column j of the MultiVector 'mv'.
//! It implements the logic of MultiVector::getVector/getVectorNonConst() for Epetra MultiVector.
//! The newly created Xpetra::EpetraVectorT will remain valid after the disappearance of the references to 'mv' in user code.
EpetraVectorT(const RCP<Epetra_MultiVector> &mv, size_t j)
: EpetraMultiVectorT<GlobalOrdinal,Node>(rcp((*mv)(j), false)), // view of the vector number j. false == I do not own the data.
internalRefToBaseMV_(mv) // keep an internal reference to the initial MultiVector to avoid desallocation of the view.
{
// The view of the internal data of 'mv' is only valid until the destruction of 'mv'.
// The new vector hold an internal reference to 'mv' in order to keep the view valid after disappearance of 'mv' references in user code.
// This implements the logic of subArray rcp (as required by the Tpetra interface).
}
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
typename dual_view_type::t_host_um getHostLocalView () const {
return this->EpetraMultiVectorT<GlobalOrdinal,Node>::getHostLocalView();
}
typename dual_view_type::t_dev_um getDeviceLocalView() const {
throw std::runtime_error("Epetra does not support device views!");
typename dual_view_type::t_dev ret;
return ret; // make compiler happy
}
/// \brief Return an unmanaged non-const view of the local data on a specific device.
/// \tparam TargetDeviceType The Kokkos Device type whose data to return.
///
/// \warning DO NOT USE THIS FUNCTION! There is no reason why you are working directly
/// with the Xpetra::EpetraVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::Vector!
///
/// \warning Be aware that the view on the vector data is non-persisting, i.e.
/// only valid as long as the vector does not run of scope!
template<class TargetDeviceType>
typename Kokkos::Impl::if_c<
Kokkos::Impl::is_same<
typename dual_view_type::t_dev_um::execution_space::memory_space,
typename TargetDeviceType::memory_space>::value,
typename dual_view_type::t_dev_um,
typename dual_view_type::t_host_um>::type
getLocalView () const {
return this->MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::template getLocalView<TargetDeviceType>();
}
#endif
//@}
private:
// This private member is only used by the constructor EpetraVectorT(const RCP<EpetraMultiVectorT<GlobalOrdinal> > &mv, size_t j). The actual private member holding the Epetra vector (vec_) is in the base class (Xpetra:EpetraMultiVectorT)
const RCP<const Epetra_MultiVector> internalRefToBaseMV_;
};
#endif
} // Xpetra namespace
#endif // XPETRA_EPETRAVECTOR_HPP
|