/usr/include/trilinos/Xpetra_EpetraMultiVector.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 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 | // @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_EPETRAMULTIVECTOR_HPP
#define XPETRA_EPETRAMULTIVECTOR_HPP
/* this file is automatically generated - do not edit (see script/epetra.py) */
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
#include <Kokkos_Core.hpp>
#include <Kokkos_DualView.hpp>
#endif
#include "Xpetra_EpetraConfigDefs.hpp"
#include "Xpetra_MultiVector.hpp"
#include "Xpetra_Vector.hpp"
#include "Xpetra_EpetraMap.hpp"
#include "Xpetra_EpetraExport.hpp"
#include "Xpetra_Utils.hpp"
#include "Xpetra_EpetraUtils.hpp"
#include "Xpetra_EpetraImport.hpp"
#include "Xpetra_Exceptions.hpp"
#include "Epetra_SerialComm.h"
#include <Epetra_MultiVector.h>
namespace Xpetra {
// TODO: move that elsewhere
template<class GlobalOrdinal, class Node>
const Epetra_MultiVector & toEpetra(const MultiVector<double,int,GlobalOrdinal,Node> &);
template<class GlobalOrdinal, class Node>
Epetra_MultiVector & toEpetra(MultiVector<double, int,GlobalOrdinal,Node> &);
template<class GlobalOrdinal, class Node>
RCP<MultiVector<double, int, GlobalOrdinal, Node> > toXpetra(RCP<Epetra_MultiVector> vec);
// we need this forward declaration
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template<class GlobalOrdinal, class Node> class EpetraVectorT;
#endif
template<class EpetraGlobalOrdinal, class Node>
class EpetraMultiVectorT
: public virtual MultiVector<double, int, EpetraGlobalOrdinal, Node>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef EpetraGlobalOrdinal GlobalOrdinal;
public:
//! @name Constructor/Destructor Methods
//@{
//! Basic MultiVector constuctor.
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true) {
TEUCHOS_TEST_FOR_EXCEPTION(true, Xpetra::Exceptions::RuntimeError,
"Xpetra::EpetraMultiVector only available for GO=int or GO=long long with EpetraNode (Serial or OpenMP depending on configuration)");
}
//! MultiVector copy constructor.
EpetraMultiVectorT(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source) {
TEUCHOS_TEST_FOR_EXCEPTION(true, Xpetra::Exceptions::RuntimeError,
"Xpetra::EpetraMultiVector only available for GO=int or GO=long long with EpetraNode (Serial or OpenMP depending on configuration)");
}
//! Set multi-vector values from array of pointers using Teuchos memory management classes. (copy).
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors) {
TEUCHOS_TEST_FOR_EXCEPTION(true, Xpetra::Exceptions::RuntimeError,
"Xpetra::EpetraMultiVector only available for GO=int or GO=long long with EpetraNode (Serial or OpenMP depending on configuration)");
}
//! MultiVector destructor.
virtual ~EpetraMultiVectorT() {}
//@}
//! @name Post-construction modification routines
//@{
//! 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) { }
//! Set all values in the multivector with the given value.
void putScalar(const Scalar &value) { }
//@}
//! @name Data copy and view methods
//@{
//! Return a Vector which is a const view of column j.
Teuchos::RCP< const Vector< double, int, GlobalOrdinal, Node > > getVector(size_t j) const {
return Teuchos::null;
}
//! Return a Vector which is a nonconst view of column j.
Teuchos::RCP< Vector< double, int, GlobalOrdinal, Node > > getVectorNonConst(size_t j) {
return Teuchos::null;
}
//! Const view of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< const Scalar > getData(size_t j) const {
return ArrayRCP<const Scalar>();
}
//! View of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j) {
return ArrayRCP<Scalar>();
}
//@}
//! @name Mathematical methods
//@{
//! 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 { }
//! Put element-wise absolute values of input Multi-vector in target: A = abs(this).
void abs(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { }
//! Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
void reciprocal(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { }
//! Scale in place: this = alpha*this.
void scale(const Scalar &alpha) { }
//! Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
void scale (Teuchos::ArrayView< const Scalar > alpha) { }
//! Update: this = beta*this + alpha*A.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta) { }
//! Update: this = gamma*this + alpha*A + beta*B.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma) { }
//! 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 { }
//! Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
void multiply(Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta) { }
//! Multiply a Vector A elementwise by a MultiVector B.
void elementWiseMultiply(Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis) { }
//@}
//! @name Attribute access functions
//@{
//! Number of columns in the multivector.
size_t getNumVectors() const { return 0; }
//! Local number of rows on the calling process.
size_t getLocalLength() const { return 0; }
//! Global number of rows in the multivector.
global_size_t getGlobalLength() const { return 0; }
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! A simple one-line description of this object.
std::string description() const { return std::string(""); }
//! Print the object with the given verbosity level to a FancyOStream.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const { }
//@}
//! Set multi-vector values to random numbers.
void randomize(bool bUseXpetraImplementation = false) { }
//! Implements DistObject interface
//{@
//! Access function for the Tpetra::Map this DistObject was constructed with.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const { return Teuchos::null; }
//! Import.
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM) { }
//! Export.
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Import< LocalOrdinal, GlobalOrdinal, Node >& importer, CombineMode CM) { }
//! Import (using an Exporter).
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) { }
//! Export (using an Importer).
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) { }
//! Replace the underlying Map in place.
void replaceMap(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map) { }
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_MultiVector object
EpetraMultiVectorT(const RCP<Epetra_MultiVector> &vec) { //TODO removed const
TEUCHOS_TEST_FOR_EXCEPTION(true, Xpetra::Exceptions::RuntimeError,
"Xpetra::EpetraMultiVector only available for GO=int or GO=long long with EpetraNode (Serial or OpenMP depending on configuration)");
}
//! Get the underlying Epetra multivector
RCP<Epetra_MultiVector> getEpetra_MultiVector() const { return Teuchos::null; }
//! Set seed for Random function.
void setSeed(unsigned int seed) { }
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
/// \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::EpetraMultiVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::MultiVector!
///
/// \warning Be aware that the view on the multivector data is non-persisting, i.e.
/// only valid as long as the multivector 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 {
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 dummy;
return dummy;
}
typename dual_view_type::t_host_um getHostLocalView () const {
return typename dual_view_type::t_host_um();
}
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_um ret;
return ret; // make compiler happy
}
#endif
//@}
protected:
/// \brief Implementation of the assignment operator (operator=);
/// does a deep copy.
virtual void
assign (const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& rhs) { }
}; // EpetraMultiVectorT class
// specialization on GO=int and Node=EpetraNode
#ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
template<>
class EpetraMultiVectorT<int, EpetraNode>
: public virtual MultiVector<double, int, int, EpetraNode>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef int GlobalOrdinal;
typedef EpetraNode Node;
public:
//! @name Constructor/Destructor Methods
//@{
//! Basic MultiVector constuctor.
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
: vec_(Teuchos::rcp(new Epetra_MultiVector(toEpetra<GlobalOrdinal,Node>(map), Teuchos::as<int>(NumVectors), zeroOut))) { }
//! MultiVector copy constructor.
EpetraMultiVectorT(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source)
: vec_(Teuchos::rcp(new Epetra_MultiVector(toEpetra<GlobalOrdinal,Node>(source)))) { }
//! Set multi-vector values from array of pointers using Teuchos memory management classes. (copy).
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors) {
//TODO: input argument 'NumVectors' is not necessary in both Xpetra and Tpetra interface. Should it be removed?
const std::string tfecfFuncName("MultiVector(ArrayOfPtrs)");
TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(NumVectors < 1 || NumVectors != Teuchos::as<size_t>(ArrayOfPtrs.size()), std::runtime_error,
": ArrayOfPtrs.size() must be strictly positive and as large as ArrayOfPtrs.");
#ifdef HAVE_XPETRA_DEBUG
// This cannot be tested by Epetra itself
{
size_t localLength = map->getNodeNumElements();
for(int j=0; j<ArrayOfPtrs.size(); j++) {
TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(Teuchos::as<size_t>(ArrayOfPtrs[j].size()) != localLength, std::runtime_error,
": ArrayOfPtrs[" << j << "].size() (== " << ArrayOfPtrs[j].size() <<
") is not equal to getLocalLength() (== " << localLength);
}
}
#endif
// Convert Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > to double**
Array<const double*> arrayOfRawPtrs(ArrayOfPtrs.size());
for(int i=0; i<ArrayOfPtrs.size(); i++) {
arrayOfRawPtrs[i] = ArrayOfPtrs[i].getRawPtr();
}
double** rawArrayOfRawPtrs = const_cast<double**>(arrayOfRawPtrs.getRawPtr()); // This const_cast should be fine, because Epetra_DataAccess=Copy.
vec_ = Teuchos::rcp(new Epetra_MultiVector(Copy, toEpetra<GlobalOrdinal,Node>(map), rawArrayOfRawPtrs, NumVectors));
}
//! MultiVector destructor.
virtual ~EpetraMultiVectorT() {}
//@}
//! @name Post-construction modification routines
//@{
//! Replace value, using global (row) index.
void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::replaceGlobalValue"); vec_->ReplaceGlobalValue(globalRow, Teuchos::as<int>(vectorIndex), value); }
//! Add value to existing value, using global (row) index.
void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::sumIntoGlobalValue"); vec_->SumIntoGlobalValue(globalRow, Teuchos::as<int>(vectorIndex), value); }
//! Replace value, using local (row) index.
void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::replaceLocalValue"); vec_->ReplaceMyValue(myRow, Teuchos::as<int>(vectorIndex), value); }
//! Add value to existing value, using local (row) index.
void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::sumIntoLocalValue"); vec_->SumIntoMyValue(myRow, Teuchos::as<int>(vectorIndex), value); }
//! Set all values in the multivector with the given value.
void putScalar(const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::putScalar"); vec_->PutScalar(value); }
//@}
//! @name Data copy and view methods
//@{
//! Return a Vector which is a const view of column j.
Teuchos::RCP< const Vector< double, int, int, EpetraNode > > getVector(size_t j) const;
//! Return a Vector which is a nonconst view of column j.
Teuchos::RCP< Vector< double, int, int, EpetraNode > > getVectorNonConst(size_t j);
//! Const view of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< const Scalar > getData(size_t j) const {
XPETRA_MONITOR("EpetraMultiVectorT::getData");
double ** arrayOfPointers;
vec_->ExtractView(&arrayOfPointers);
double * data = arrayOfPointers[j];
int localLength = vec_->MyLength();
return ArrayRCP<double>(data, 0, localLength, false); // no ownership
}
//! View of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j) {
XPETRA_MONITOR("EpetraMultiVectorT::getDataNonConst");
double ** arrayOfPointers;
vec_->ExtractView(&arrayOfPointers);
double * data = arrayOfPointers[j];
int localLength = vec_->MyLength();
return ArrayRCP<double>(data, 0, localLength, false); // no ownership
}
//@}
//! @name Mathematical methods
//@{
//! 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 {
XPETRA_MONITOR("EpetraMultiVectorT::dot");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, A, eA, "This Xpetra::EpetraMultiVectorT method only accept Xpetra::EpetraMultiVectorT as input arguments.");
vec_->Dot(*eA.getEpetra_MultiVector(), dots.getRawPtr());
}
//! Put element-wise absolute values of input Multi-vector in target: A = abs(this).
void abs(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { XPETRA_MONITOR("EpetraMultiVectorT::abs"); vec_->Abs(toEpetra<GlobalOrdinal,Node>(A)); }
//! Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
void reciprocal(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { XPETRA_MONITOR("EpetraMultiVectorT::reciprocal"); vec_->Reciprocal(toEpetra<GlobalOrdinal,Node>(A)); }
//! Scale in place: this = alpha*this.
void scale(const Scalar &alpha) { XPETRA_MONITOR("EpetraMultiVectorT::scale"); vec_->Scale(alpha); }
//! Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
void scale (Teuchos::ArrayView< const Scalar > alpha) {
XPETRA_MONITOR("EpetraMultiVectorT::scale");
// Epetra, unlike Tpetra, doesn't implement this version of
// scale(). Deal with this by scaling one column at a time.
const size_t numVecs = this->getNumVectors ();
for (size_t j = 0; j < numVecs; ++j) {
vec_->Scale (alpha[j]);
}
}
//! Update: this = beta*this + alpha*A.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta) { XPETRA_MONITOR("EpetraMultiVectorT::update"); vec_->Update(alpha, toEpetra<GlobalOrdinal,Node>(A), beta); }
//! Update: this = gamma*this + alpha*A + beta*B.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma) { XPETRA_MONITOR("EpetraMultiVectorT::update"); vec_->Update(alpha, toEpetra<GlobalOrdinal,Node>(A), beta, toEpetra<GlobalOrdinal,Node>(B), gamma); }
//! Compute 1-norm of each vector in multi-vector.
void norm1(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::norm1"); vec_->Norm1(norms.getRawPtr()); }
//!
void norm2(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::norm2"); vec_->Norm2(norms.getRawPtr()); }
//! Compute Inf-norm of each vector in multi-vector.
void normInf(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::normInf"); vec_->NormInf(norms.getRawPtr()); }
//! 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 { XPETRA_MONITOR("EpetraMultiVectorT::meanValue"); vec_->MeanValue(means.getRawPtr()); } //TODO: modify ArrayView size ??
//! Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
void multiply(Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta) { XPETRA_MONITOR("EpetraMultiVectorT::multiply"); vec_->Multiply(toEpetra(transA), toEpetra(transB), alpha, toEpetra(A), toEpetra(B), beta); }
//! Multiply a Vector A elementwise by a MultiVector B.
void elementWiseMultiply(Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis) { XPETRA_MONITOR("EpetraMultiVectorT::elementWiseMultiply"); vec_->Multiply(scalarAB, toEpetra<GlobalOrdinal,Node>(A), toEpetra<GlobalOrdinal,Node>(B), scalarThis); }
//@}
//! @name Attribute access functions
//@{
//! Number of columns in the multivector.
size_t getNumVectors() const { XPETRA_MONITOR("EpetraMultiVectorT::getNumVectors"); return vec_->NumVectors(); }
//! Local number of rows on the calling process.
size_t getLocalLength() const { XPETRA_MONITOR("EpetraMultiVectorT::getLocalLength"); return vec_->MyLength(); }
//! Global number of rows in the multivector.
global_size_t getGlobalLength() const { XPETRA_MONITOR("EpetraMultiVectorT::getGlobalLength"); return vec_->GlobalLength64(); }
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! A simple one-line description of this object.
std::string description() const {
XPETRA_MONITOR("EpetraMultiVectorT::description");
TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO");
return "TODO";
}
//! Print the object with the given verbosity level to a FancyOStream.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {
XPETRA_MONITOR("EpetraMultiVectorT::describe");
vec_->Print(out);
}
//@}
//! Set multi-vector values to random numbers.
void randomize(bool bUseXpetraImplementation = false) {
XPETRA_MONITOR("EpetraMultiVectorT::randomize");
if (bUseXpetraImplementation)
Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize();
else
vec_->Random();
}
//! Implements DistObject interface
//{@
//! Access function for the Tpetra::Map this DistObject was constructed with.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const { XPETRA_MONITOR("EpetraMultiVectorT::getMap"); return toXpetra<GlobalOrdinal,Node>(vec_->Map()); }
//! Import.
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doImport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, source, tSource, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraImportT<GlobalOrdinal XPETRA_COMMA Node>, importer, tImporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tSource.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Import(*v, *tImporter.getEpetra_Import(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra is " << err);
}
//! Export.
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Import< LocalOrdinal, GlobalOrdinal, Node >& importer, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doExport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, dest, tDest, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraImportT<GlobalOrdinal XPETRA_COMMA Node>, importer, tImporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tDest.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Export(*v, *tImporter.getEpetra_Import(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Import (using an Exporter).
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doImport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, source, tSource, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraExportT<GlobalOrdinal XPETRA_COMMA Node>, exporter, tExporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tSource.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Import(*v, *tExporter.getEpetra_Export(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Export (using an Importer).
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doExport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, dest, tDest, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraExportT<GlobalOrdinal XPETRA_COMMA Node>, exporter, tExporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tDest.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Export(*v, *tExporter.getEpetra_Export(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Replace the underlying Map in place.
void replaceMap(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map) {
XPETRA_MONITOR("EpetraMultiVectorT::replaceMap");
int err = 0;
if (!map.is_null()) {
err = this->getEpetra_MultiVector()->ReplaceMap(toEpetra<GlobalOrdinal,Node>(map));
} else {
// Replace map with a dummy map to avoid potential hangs later
Epetra_SerialComm SComm;
Epetra_Map NewMap((GlobalOrdinal) vec_->MyLength(), (GlobalOrdinal) vec_->Map().IndexBase64(), SComm);
err = this->getEpetra_MultiVector()->ReplaceMap(NewMap);
}
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_MultiVector object
EpetraMultiVectorT(const RCP<Epetra_MultiVector> &vec) : vec_(vec) { } //TODO removed const
//! Get the underlying Epetra multivector
RCP<Epetra_MultiVector> getEpetra_MultiVector() const { return vec_; }
//! Set seed for Random function.
void setSeed(unsigned int seed) {
XPETRA_MONITOR("EpetraMultiVectorT::seedrandom");
Teuchos::ScalarTraits< Scalar >::seedrandom(seed);
vec_->SetSeed(seed);
}
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
/// \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::EpetraMultiVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::MultiVector!
///
/// \warning Be aware that the view on the multivector data is non-persisting, i.e.
/// only valid as long as the multivector 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>();
}
typename dual_view_type::t_host_um getHostLocalView () const {
typedef Kokkos::View< typename dual_view_type::t_host::data_type ,
Kokkos::LayoutLeft,
typename dual_view_type::t_host::device_type ,
Kokkos::MemoryUnmanaged> epetra_view_type;
// access Epetra multivector data
double* data = NULL;
int myLDA;
vec_->ExtractView(&data, &myLDA);
int localLength = vec_->MyLength();
int numVectors = getNumVectors();
// create view
epetra_view_type test = epetra_view_type(data, localLength, numVectors);
typename dual_view_type::t_host_um ret = subview(test, Kokkos::ALL(), Kokkos::ALL());
return ret;
}
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_um ret;
return ret; // make compiler happy
}
#endif
//@}
protected:
/// \brief Implementation of the assignment operator (operator=);
/// does a deep copy.
virtual void
assign (const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& rhs) {
typedef EpetraMultiVectorT this_type;
const this_type* rhsPtr = dynamic_cast<const this_type*> (&rhs);
TEUCHOS_TEST_FOR_EXCEPTION(
rhsPtr == NULL, std::invalid_argument, "Xpetra::MultiVector::operator=: "
"The left-hand side (LHS) of the assignment has a different type than "
"the right-hand side (RHS). The LHS has type Xpetra::EpetraMultiVectorT "
"(which means it wraps an Epetra_MultiVector), but the RHS has some "
"other type. This probably means that the RHS wraps a Tpetra::Multi"
"Vector. Xpetra::MultiVector does not currently implement assignment "
"from a Tpetra object to an Epetra object, though this could be added "
"with sufficient interest.");
RCP<const Epetra_MultiVector> rhsImpl = rhsPtr->getEpetra_MultiVector ();
RCP<Epetra_MultiVector> lhsImpl = this->getEpetra_MultiVector ();
TEUCHOS_TEST_FOR_EXCEPTION(
rhsImpl.is_null (), std::logic_error, "Xpetra::MultiVector::operator= "
"(in Xpetra::EpetraMultiVectorT::assign): *this (the right-hand side of "
"the assignment) has a null RCP<Epetra_MultiVector> inside. Please "
"report this bug to the Xpetra developers.");
TEUCHOS_TEST_FOR_EXCEPTION(
lhsImpl.is_null (), std::logic_error, "Xpetra::MultiVector::operator= "
"(in Xpetra::EpetraMultiVectorT::assign): The left-hand side of the "
"assignment has a null RCP<Epetra_MultiVector> inside. Please report "
"this bug to the Xpetra developers.");
// Epetra_MultiVector's assignment operator does a deep copy.
*lhsImpl = *rhsImpl;
}
private:
//! The Epetra_MultiVector which this class wraps.
RCP< Epetra_MultiVector > vec_;
}; // EpetraMultiVectorT class (specialization on GO=int, NO=EpetraNode
#endif
// specialization on GO=long long and EpetraNode
#ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
template<>
class EpetraMultiVectorT<long long, EpetraNode>
: public virtual MultiVector<double, int, long long, EpetraNode>
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef long long GlobalOrdinal;
typedef EpetraNode Node;
public:
//! @name Constructor/Destructor Methods
//@{
//! Basic MultiVector constuctor.
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
: vec_(Teuchos::rcp(new Epetra_MultiVector(toEpetra<GlobalOrdinal,Node>(map), Teuchos::as<int>(NumVectors), zeroOut))) { }
//! MultiVector copy constructor.
EpetraMultiVectorT(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source)
: vec_(Teuchos::rcp(new Epetra_MultiVector(toEpetra<GlobalOrdinal,Node>(source)))) { }
//! Set multi-vector values from array of pointers using Teuchos memory management classes. (copy).
EpetraMultiVectorT(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors) {
//TODO: input argument 'NumVectors' is not necessary in both Xpetra and Tpetra interface. Should it be removed?
const std::string tfecfFuncName("MultiVector(ArrayOfPtrs)");
TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(NumVectors < 1 || NumVectors != Teuchos::as<size_t>(ArrayOfPtrs.size()), std::runtime_error,
": ArrayOfPtrs.size() must be strictly positive and as large as ArrayOfPtrs.");
#ifdef HAVE_XPETRA_DEBUG
// This cannot be tested by Epetra itself
{
size_t localLength = map->getNodeNumElements();
for(int j=0; j<ArrayOfPtrs.size(); j++) {
TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(Teuchos::as<size_t>(ArrayOfPtrs[j].size()) != localLength, std::runtime_error,
": ArrayOfPtrs[" << j << "].size() (== " << ArrayOfPtrs[j].size() <<
") is not equal to getLocalLength() (== " << localLength);
}
}
#endif
// Convert Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > to double**
Array<const double*> arrayOfRawPtrs(ArrayOfPtrs.size());
for(int i=0; i<ArrayOfPtrs.size(); i++) {
arrayOfRawPtrs[i] = ArrayOfPtrs[i].getRawPtr();
}
double** rawArrayOfRawPtrs = const_cast<double**>(arrayOfRawPtrs.getRawPtr()); // This const_cast should be fine, because Epetra_DataAccess=Copy.
vec_ = Teuchos::rcp(new Epetra_MultiVector(Copy, toEpetra<GlobalOrdinal,Node>(map), rawArrayOfRawPtrs, NumVectors));
}
//! MultiVector destructor.
virtual ~EpetraMultiVectorT() {}
//@}
//! @name Post-construction modification routines
//@{
//! Replace value, using global (row) index.
void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::replaceGlobalValue"); vec_->ReplaceGlobalValue(globalRow, Teuchos::as<int>(vectorIndex), value); }
//! Add value to existing value, using global (row) index.
void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::sumIntoGlobalValue"); vec_->SumIntoGlobalValue(globalRow, Teuchos::as<int>(vectorIndex), value); }
//! Replace value, using local (row) index.
void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::replaceLocalValue"); vec_->ReplaceMyValue(myRow, Teuchos::as<int>(vectorIndex), value); }
//! Add value to existing value, using local (row) index.
void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::sumIntoLocalValue"); vec_->SumIntoMyValue(myRow, Teuchos::as<int>(vectorIndex), value); }
//! Set all values in the multivector with the given value.
void putScalar(const Scalar &value) { XPETRA_MONITOR("EpetraMultiVectorT::putScalar"); vec_->PutScalar(value); }
//@}
//! @name Data copy and view methods
//@{
//! Return a Vector which is a const view of column j.
Teuchos::RCP< const Vector< double, int, long long, EpetraNode > > getVector(size_t j) const;
//! Return a Vector which is a nonconst view of column j.
Teuchos::RCP< Vector< double, int, long long, EpetraNode > > getVectorNonConst(size_t j);
//! Const view of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< const Scalar > getData(size_t j) const {
XPETRA_MONITOR("EpetraMultiVectorT::getData");
double ** arrayOfPointers;
vec_->ExtractView(&arrayOfPointers);
double * data = arrayOfPointers[j];
int localLength = vec_->MyLength();
return ArrayRCP<double>(data, 0, localLength, false); // no ownership
}
//! View of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j) {
XPETRA_MONITOR("EpetraMultiVectorT::getDataNonConst");
double ** arrayOfPointers;
vec_->ExtractView(&arrayOfPointers);
double * data = arrayOfPointers[j];
int localLength = vec_->MyLength();
return ArrayRCP<double>(data, 0, localLength, false); // no ownership
}
//@}
//! @name Mathematical methods
//@{
//! 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 {
XPETRA_MONITOR("EpetraMultiVectorT::dot");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, A, eA, "This Xpetra::EpetraMultiVectorT method only accept Xpetra::EpetraMultiVectorT as input arguments.");
vec_->Dot(*eA.getEpetra_MultiVector(), dots.getRawPtr());
}
//! Put element-wise absolute values of input Multi-vector in target: A = abs(this).
void abs(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { XPETRA_MONITOR("EpetraMultiVectorT::abs"); vec_->Abs(toEpetra<GlobalOrdinal,Node>(A)); }
//! Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
void reciprocal(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) { XPETRA_MONITOR("EpetraMultiVectorT::reciprocal"); vec_->Reciprocal(toEpetra<GlobalOrdinal,Node>(A)); }
//! Scale in place: this = alpha*this.
void scale(const Scalar &alpha) { XPETRA_MONITOR("EpetraMultiVectorT::scale"); vec_->Scale(alpha); }
//! Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
void scale (Teuchos::ArrayView< const Scalar > alpha) {
XPETRA_MONITOR("EpetraMultiVectorT::scale");
// Epetra, unlike Tpetra, doesn't implement this version of
// scale(). Deal with this by scaling one column at a time.
const size_t numVecs = this->getNumVectors ();
for (size_t j = 0; j < numVecs; ++j) {
vec_->Scale (alpha[j]);
}
}
//! Update: this = beta*this + alpha*A.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta) { XPETRA_MONITOR("EpetraMultiVectorT::update"); vec_->Update(alpha, toEpetra<GlobalOrdinal,Node>(A), beta); }
//! Update: this = gamma*this + alpha*A + beta*B.
void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma) { XPETRA_MONITOR("EpetraMultiVectorT::update"); vec_->Update(alpha, toEpetra<GlobalOrdinal,Node>(A), beta, toEpetra<GlobalOrdinal,Node>(B), gamma); }
//! Compute 1-norm of each vector in multi-vector.
void norm1(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::norm1"); vec_->Norm1(norms.getRawPtr()); }
//!
void norm2(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::norm2"); vec_->Norm2(norms.getRawPtr()); }
//! Compute Inf-norm of each vector in multi-vector.
void normInf(const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const { XPETRA_MONITOR("EpetraMultiVectorT::normInf"); vec_->NormInf(norms.getRawPtr()); }
//! 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 { XPETRA_MONITOR("EpetraMultiVectorT::meanValue"); vec_->MeanValue(means.getRawPtr()); } //TODO: modify ArrayView size ??
//! Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
void multiply(Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta) { XPETRA_MONITOR("EpetraMultiVectorT::multiply"); vec_->Multiply(toEpetra(transA), toEpetra(transB), alpha, toEpetra(A), toEpetra(B), beta); }
//! Multiply a Vector A elementwise by a MultiVector B.
void elementWiseMultiply(Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis) { XPETRA_MONITOR("EpetraMultiVectorT::elementWiseMultiply"); vec_->Multiply(scalarAB, toEpetra<GlobalOrdinal,Node>(A), toEpetra<GlobalOrdinal,Node>(B), scalarThis); }
//@}
//! @name Attribute access functions
//@{
//! Number of columns in the multivector.
size_t getNumVectors() const { XPETRA_MONITOR("EpetraMultiVectorT::getNumVectors"); return vec_->NumVectors(); }
//! Local number of rows on the calling process.
size_t getLocalLength() const { XPETRA_MONITOR("EpetraMultiVectorT::getLocalLength"); return vec_->MyLength(); }
//! Global number of rows in the multivector.
global_size_t getGlobalLength() const { XPETRA_MONITOR("EpetraMultiVectorT::getGlobalLength"); return vec_->GlobalLength64(); }
//@}
//! @name Overridden from Teuchos::Describable
//@{
//! A simple one-line description of this object.
std::string description() const {
XPETRA_MONITOR("EpetraMultiVectorT::description");
TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO");
return "TODO";
}
//! Print the object with the given verbosity level to a FancyOStream.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {
XPETRA_MONITOR("EpetraMultiVectorT::describe");
vec_->Print(out);
}
//@}
//! Set multi-vector values to random numbers.
void randomize(bool bUseXpetraImplementation = false) {
XPETRA_MONITOR("EpetraMultiVectorT::randomize");
if (bUseXpetraImplementation)
Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize();
else
vec_->Random();
}
//! Implements DistObject interface
//{@
//! Access function for the Tpetra::Map this DistObject was constructed with.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const { XPETRA_MONITOR("EpetraMultiVectorT::getMap"); return toXpetra<GlobalOrdinal,Node>(vec_->Map()); }
//! Import.
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doImport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, source, tSource, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraImportT<GlobalOrdinal XPETRA_COMMA Node>, importer, tImporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tSource.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Import(*v, *tImporter.getEpetra_Import(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra is " << err);
}
//! Export.
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Import< LocalOrdinal, GlobalOrdinal, Node >& importer, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doExport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, dest, tDest, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraImportT<GlobalOrdinal XPETRA_COMMA Node>, importer, tImporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tDest.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Export(*v, *tImporter.getEpetra_Import(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Import (using an Exporter).
void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &source, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doImport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, source, tSource, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraExportT<GlobalOrdinal XPETRA_COMMA Node>, exporter, tExporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tSource.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Import(*v, *tExporter.getEpetra_Export(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Export (using an Importer).
void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &dest, const Export< LocalOrdinal, GlobalOrdinal, Node >& exporter, CombineMode CM) {
XPETRA_MONITOR("EpetraMultiVectorT::doExport");
XPETRA_DYNAMIC_CAST(const EpetraMultiVectorT<GlobalOrdinal XPETRA_COMMA Node>, dest, tDest, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraMultiVectorT as input arguments.");
XPETRA_DYNAMIC_CAST(const EpetraExportT<GlobalOrdinal XPETRA_COMMA Node>, exporter, tExporter, "Xpetra::EpetraMultiVectorT::doImport only accept Xpetra::EpetraImportT as input arguments.");
RCP<Epetra_MultiVector> v = tDest.getEpetra_MultiVector();
int err = this->getEpetra_MultiVector()->Export(*v, *tExporter.getEpetra_Export(), toEpetra(CM));
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//! Replace the underlying Map in place.
void replaceMap(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map) {
XPETRA_MONITOR("EpetraMultiVectorT::replaceMap");
int err = 0;
if (!map.is_null()) {
err = this->getEpetra_MultiVector()->ReplaceMap(toEpetra<GlobalOrdinal,Node>(map));
} else {
// Replace map with a dummy map to avoid potential hangs later
Epetra_SerialComm SComm;
Epetra_Map NewMap((GlobalOrdinal) vec_->MyLength(), (GlobalOrdinal) vec_->Map().IndexBase64(), SComm);
err = this->getEpetra_MultiVector()->ReplaceMap(NewMap);
}
TEUCHOS_TEST_FOR_EXCEPTION(err != 0, std::runtime_error, "Catch error code returned by Epetra.");
}
//@}
//! @name Xpetra specific
//@{
//! EpetraMultiVectorT constructor to wrap a Epetra_MultiVector object
EpetraMultiVectorT(const RCP<Epetra_MultiVector> &vec) : vec_(vec) { } //TODO removed const
//! Get the underlying Epetra multivector
RCP<Epetra_MultiVector> getEpetra_MultiVector() const { return vec_; }
//! Set seed for Random function.
void setSeed(unsigned int seed) {
XPETRA_MONITOR("EpetraMultiVectorT::seedrandom");
Teuchos::ScalarTraits< Scalar >::seedrandom(seed);
vec_->SetSeed(seed);
}
#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
/// \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::EpetraMultiVector object. To write a code which is independent
/// from the underlying linear algebra package you should always use the abstract class,
/// i.e. Xpetra::MultiVector!
///
/// \warning Be aware that the view on the multivector data is non-persisting, i.e.
/// only valid as long as the multivector 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>();
}
typename dual_view_type::t_host_um getHostLocalView () const {
typedef Kokkos::View< typename dual_view_type::t_host::data_type ,
Kokkos::LayoutLeft,
typename dual_view_type::t_host::device_type ,
Kokkos::MemoryUnmanaged> epetra_view_type;
// access Epetra multivector data
double* data = NULL;
int myLDA;
vec_->ExtractView(&data, &myLDA);
int localLength = vec_->MyLength();
int numVectors = getNumVectors();
// create view
epetra_view_type test = epetra_view_type(data, localLength, numVectors);
typename dual_view_type::t_host_um ret = subview(test, Kokkos::ALL(), Kokkos::ALL());
return ret;
}
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_um ret;
return ret; // make compiler happy
}
#endif
//@}
protected:
/// \brief Implementation of the assignment operator (operator=);
/// does a deep copy.
virtual void
assign (const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& rhs) {
typedef EpetraMultiVectorT this_type;
const this_type* rhsPtr = dynamic_cast<const this_type*> (&rhs);
TEUCHOS_TEST_FOR_EXCEPTION(
rhsPtr == NULL, std::invalid_argument, "Xpetra::MultiVector::operator=: "
"The left-hand side (LHS) of the assignment has a different type than "
"the right-hand side (RHS). The LHS has type Xpetra::EpetraMultiVectorT "
"(which means it wraps an Epetra_MultiVector), but the RHS has some "
"other type. This probably means that the RHS wraps a Tpetra::Multi"
"Vector. Xpetra::MultiVector does not currently implement assignment "
"from a Tpetra object to an Epetra object, though this could be added "
"with sufficient interest.");
RCP<const Epetra_MultiVector> rhsImpl = rhsPtr->getEpetra_MultiVector ();
RCP<Epetra_MultiVector> lhsImpl = this->getEpetra_MultiVector ();
TEUCHOS_TEST_FOR_EXCEPTION(
rhsImpl.is_null (), std::logic_error, "Xpetra::MultiVector::operator= "
"(in Xpetra::EpetraMultiVectorT::assign): *this (the right-hand side of "
"the assignment) has a null RCP<Epetra_MultiVector> inside. Please "
"report this bug to the Xpetra developers.");
TEUCHOS_TEST_FOR_EXCEPTION(
lhsImpl.is_null (), std::logic_error, "Xpetra::MultiVector::operator= "
"(in Xpetra::EpetraMultiVectorT::assign): The left-hand side of the "
"assignment has a null RCP<Epetra_MultiVector> inside. Please report "
"this bug to the Xpetra developers.");
// Epetra_MultiVector's assignment operator does a deep copy.
*lhsImpl = *rhsImpl;
}
private:
//! The Epetra_MultiVector which this class wraps.
RCP< Epetra_MultiVector > vec_;
}; // EpetraMultiVectorT class (specialization on GO=long long, NO=EpetraNode
#endif
} // Xpetra namespace
#include "Xpetra_EpetraVector.hpp" // to avoid incomplete type instantiated above in out-of-body functions.
#endif // XPETRA_EPETRAMULTIVECTOR_HPP
|