/usr/include/trilinos/BelosEpetraAdapter.hpp is in libtrilinos-belos-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 | //@HEADER
// ************************************************************************
//
// Belos: Block Linear Solvers Package
// Copyright 2004 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
#ifndef BELOS_EPETRA_ADAPTER_HPP
#define BELOS_EPETRA_ADAPTER_HPP
/*! \file BelosEpetraAdapter.hpp
\brief Provides several interfaces between Belos virtual classes and Epetra concrete classes.
*/
#include "Epetra_MultiVector.h"
#include "Epetra_Operator.h"
#include "Epetra_Map.h"
#include "Epetra_LocalMap.h"
#include "Teuchos_SerialDenseMatrix.hpp"
#include "BelosConfigDefs.hpp"
#include "BelosMultiVec.hpp"
#include "BelosOperator.hpp"
#include "BelosTypes.hpp"
#ifdef HAVE_BELOS_TSQR
// This header file actually lives in the Tpetra package.
//
// mfh 07 Sep 2012: Back in 2010, I had to put Epetra's TSQR adapter
// in Tpetra. This was because an external software package was
// linking to Epetra without using Trilinos' Makefile.export mechanism
// to consider which Trilinos libraries to use. Making Epetra
// optionally depend on Kokkos (to make TSQR work) changed the list of
// libraries, and that software package wasn't doing the right thing
// to adjust. In any case, I chose at the time to put Epetra's TSQR
// adapter in Tpetra, since Tpetra already had an optional dependency
// on Epetra. So, for better or worse, you won't be able to use TSQR
// with Epetra unless you enable both Epetra and Tpetra in your
// Trilinos build. HAVE_BELOS_TSQR will correctly reflect this: it
// won't be defined unless both Epetra and Tpetra are enabled in your
// Trilinos build.
# include <Epetra_TsqrAdaptor.hpp>
#endif // HAVE_BELOS_TSQR
namespace Belos {
//! @name Epetra Adapter Exceptions
//@{
/** \brief EpetraMultiVecFailure is thrown when a return value from an Epetra
* call on an Epetra_MultiVector is non-zero.
*/
class EpetraMultiVecFailure : public BelosError {public:
EpetraMultiVecFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
/** \brief EpetraOpFailure is thrown when a return value from an Epetra
* call on an Epetra_Operator is non-zero.
*/
class EpetraOpFailure : public BelosError {public:
EpetraOpFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
//@}
/// \class EpetraMultiVec
/// \brief Implementation of Belos::MultiVec using Epetra_MultiVector.
///
/// Belos::MultiVec offers a simple abstract interface for
/// multivector operations in Belos solver algorithms. This class
/// implements Belos::MultiVec by extending Epetra_MultiVector.
class EpetraMultiVec : public MultiVec<double>, public Epetra_MultiVector {
public:
// constructors
EpetraMultiVec(const Epetra_BlockMap& Map_in, double * array, const int numvecs, const int stride=0);
EpetraMultiVec(const Epetra_BlockMap& Map_in, const int numvecs, bool zeroOut=true);
EpetraMultiVec(Epetra_DataAccess CV_in, const Epetra_MultiVector& P_vec, const std::vector<int>& index);
EpetraMultiVec& operator=(const EpetraMultiVec& pv) { Epetra_MultiVector::operator=(pv); return *this; }
EpetraMultiVec(const Epetra_MultiVector & P_vec);
~EpetraMultiVec();
//! @name Member functions inherited from Belos::MultiVec
//@{
/// A virtual "copy constructor" that returns a pointer to a new
/// object of the pure virtual class. This vector's entries are
/// not copied; instead, a new MultiVec is created with the same
/// data distribution, but with numvecs columns (numvecs > 0).
///
/// \param numvecs [in] The number of columns in the output
/// multivector. Must be positive.
MultiVec<double> * Clone ( const int numvecs ) const;
/// A virtual "copy constructor" returning a pointer to a new
/// object of the pure virtual class. This vector's entries are
/// copied and a new stand-alone multivector is created. (deep
/// copy).
MultiVec<double> * CloneCopy () const;
/// A virtual "copy constructor" returning a pointer to the pure
/// virtual class. This vector's entries are copied and a new
/// stand-alone MultiVector is created where only selected columns
/// are chosen. (deep copy).
MultiVec<double> * CloneCopy ( const std::vector<int>& index ) const;
/// A virtual view "constructor" returning a pointer to the pure
/// virtual class. This vector's entries are shared and hence no
/// memory is allocated for the columns.
MultiVec<double> * CloneViewNonConst ( const std::vector<int>& index );
/// A virtual view constructor returning a pointer to the pure
/// virtual class. This vector's entries are shared and hence no
/// memory is allocated for the columns.
const MultiVec<double> * CloneView ( const std::vector<int>& index ) const;
/// Set a subblock of the multivector, which need not be
/// contiguous, and is given by the indices.
void SetBlock ( const MultiVec<double>& A, const std::vector<int>& index );
//! The number of rows in the multivector.
ptrdiff_t GetGlobalLength () const
{
if ( Map().GlobalIndicesLongLong() )
return static_cast<ptrdiff_t>( GlobalLength64() );
else
return static_cast<ptrdiff_t>( GlobalLength() );
}
//! The number of columns in the multivector.
int GetNumberVecs () const { return NumVectors(); }
//! *this <- alpha * A * B + beta * (*this)
void MvTimesMatAddMv ( const double alpha, const MultiVec<double>& A,
const Teuchos::SerialDenseMatrix<int,double>& B, const double beta );
//! *this <- alpha * A + beta * B
void MvAddMv ( const double alpha, const MultiVec<double>& A, const double beta,
const MultiVec<double>& B);
//! Scale each element of the vectors in \c *this with \c alpha.
void MvScale ( const double alpha ) {
TEUCHOS_TEST_FOR_EXCEPTION( this->Scale( alpha )!=0, EpetraMultiVecFailure,
"Belos::EpetraMultiVec::MvScale() call to Scale() returned a nonzero value."); }
//! Scale each element of the \c i-th vector in \c *this with \c alpha[i].
void MvScale ( const std::vector<double>& alpha );
//! B <- alpha * A^T * (*this)
void MvTransMv ( const double alpha, const MultiVec<double>& A, Teuchos::SerialDenseMatrix<int,double>& B ) const;
//! b[i] = A[i]^T * this[i]
void MvDot ( const MultiVec<double>& A, std::vector<double>& b ) const;
//! alpha[i] = norm of i-th column of (*this)
void MvNorm ( std::vector<double>& normvec, NormType norm_type = TwoNorm ) const;
//! Fill all columns of *this with random values.
void MvRandom() {
TEUCHOS_TEST_FOR_EXCEPTION( Random()!=0, EpetraMultiVecFailure,
"Belos::EpetraMultiVec::MvRandom() call to Random() returned a nonzero value."); }
//! Initialize each element of (*this) to the scalar value alpha.
void MvInit ( const double alpha ) {
TEUCHOS_TEST_FOR_EXCEPTION( PutScalar(alpha)!=0, EpetraMultiVecFailure,
"Belos::EpetraMultiVec::MvInit() call to PutScalar() returned a nonzero value."); }
//! Print (*this) to the given output stream.
void MvPrint( std::ostream& os ) const { os << *this << std::endl; };
private:
};
/// \class EpetraOp
/// \brief Belos::Operator implementation that wraps an Epetra_Operator instance.
///
/// An instance of this class wraps an Epetra_Operator instance so
/// that it can be handled as a Belos::Operator. Its Apply() method
/// just invokes the underlying Epetra_Operator's Apply().
///
/// Important note on applying the transpose: Epetra_Operator
/// objects, unlike Tpetra or Thyra operators, have a persistent
/// "use the transpose" state. This state can be set or unset using
/// Epetra_Operator::SetUseTranspose(). Epetra_Operator instances
/// are not required to implement applying the transpose. However,
/// if the wrapped Epetra_Operator object does implement applying
/// the transpose, and if its transpose state is set on input,
/// EpetraOp follows the convention that calling Apply() with
/// trans=TRANS (or CONJTRANS) applies the transpose, not the
/// transpose of the transpose. Similarly, calling Apply() with
/// trans=NOTRANS temporary unsets the transpose state, applies the
/// operator, and restores the transpose state on exit. This
/// preserves the historical behavior of Belos' Epetra interface,
/// without permanently changing the state of the operator.
///
class EpetraOp : public virtual Operator<double> {
public:
/// \brief Constructor.
///
/// \param Op [in] The Epetra_Operator instance to wrap.
EpetraOp (const Teuchos::RCP<Epetra_Operator> &Op);
//! Destructor.
~EpetraOp () {}
//! Apply the operator (or its transpose) to x and put the result in y.
void Apply (const MultiVec<double>& x,
MultiVec<double>& y,
ETrans trans=NOTRANS) const;
//! Whether the operator knows how to apply its transpose.
bool HasApplyTranspose() const;
private:
Teuchos::RCP<Epetra_Operator> Epetra_Op;
};
/// \class EpetraPrecOp
/// \brief Belos::Operator implementation that wraps Epetra_Operator as a preconditioner.
///
/// An instance of this class wraps an \c Epetra_Operator, when the
/// wrapped operator is a preconditioner or other object that is
/// normally applied using ApplyInverse(). EpetraPrecOp's \c
/// Apply() method thus invokes the underlying object's
/// Epetra_Operator::ApplyInverse() method, and its \c
/// ApplyInverse() method invokes the underlying object's
/// Epetra_Operator::Apply() method.
///
/// EpetraPrecOp implements both \c Belos::Operator and
/// Epetra_Operator. Thus, you can use it in Belos' templated
/// solvers with either the OP = Belos::Operator or OP =
/// Epetra_Operator specializations.
///
class EpetraPrecOp :
public virtual Operator<double>,
public virtual Epetra_Operator
{
public:
/// Basic constructor.
///
/// \param Op [in/out] The operator to wrap. EpetraPrecOp's
/// Apply() method will invoke this operator's ApplyInverse()
/// method, and vice versa.
EpetraPrecOp (const Teuchos::RCP<Epetra_Operator>& Op);
//! Virtual destructor, for memory safety of derived classes.
virtual ~EpetraPrecOp() {};
/// \brief Apply the operator (or its transpose) to x, putting the result in y.
///
/// This method is part of the Belos::MultiVec implementation.
/// EpetraPrecOp's Apply() methods invoke the underlying
/// operator's ApplyInverse() method.
///
/// All Epetra operators are real-valued, never complex-valued, so
/// setting either trans=CONJTRANS or trans=TRANS means that this
/// method will attempt to apply the transpose. If you attempt to
/// apply the transpose, EpetraPrecOp will invoke the underlying
/// operator's SetUseTranspose() method. This may or may not
/// succeed. If it does <i>not</i> succeed, this method will
/// throw an \c EpetraOpFailure exception. Furthermore, if the
/// underlying operator's ApplyInverse() method does not succeed
/// (i.e., returns a nonzero error code), this method will throw
/// an \c EpetraOpFailure exception.
///
/// \note The trans argument will always have its literal meaning,
/// even if the underlying Epetra_Operator's transpose flag is
/// set (i.e., if UseTranspose()==true). Implementing this
/// requires temporarily changing the transpose flag of the
/// underlying operator. However, the flag will be changed back
/// to its original value before this method returns, whatever
/// that original value was. This behavior is <i>different</i>
/// than that of the two-argument version of Apply() below,
/// because the three-argument version of Apply() here
/// implements the Belos::Operator and Belos::OperatorTraits
/// interfaces. Those interfaces expect the transpose-ness of
/// the operator to be stateless.
void
Apply (const MultiVec<double>& x,
MultiVec<double>& y,
ETrans trans=NOTRANS) const;
//! Whether the operator knows how to apply its transpose.
bool HasApplyTranspose() const;
/// \brief Apply the operator to x, putting the result in y.
///
/// This method is part of the Epetra_MultiVector implementation.
/// EpetraPrecOp's Apply() methods invoke the underlying
/// operator's ApplyInverse() method. This version of Apply()
/// does <i>not</i> attempt to check for errors, but it returns
/// the error code that the underlying operator's ApplyInverse()
/// method returns.
///
/// \note If the underlying operator's transpose flag is set
/// (i.e., if UseTranspose() returns true), then EpetraPrecOp
/// will apply the transpose of the inverse. This behavior is
/// <i>different</i> than that of the three-argument version of
/// Apply() above. This is so because the two-argument version
/// of Apply() implements Epetra_Operator, which expects the
/// effect of SetUseTranspose() to persist for all subsequent
/// calls to Apply() and ApplyInverse().
///
/// \return Zero if successful, else nonzero. The value of the
/// error code is the same as would be returned by the
/// underlying operator's ApplyInverse() method.
int
Apply (const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const;
/// \brief Apply inverse method for an Epetra_MultiVector.
///
/// This method is part of the Epetra_MultiVector implementation.
/// EpetraPrecOp's ApplyInverse() method invokes the underlying
/// operator's Apply() method. This method does <i>not</i>
/// attempt to check for errors, but it returns the error code
/// that the underlying operator's Apply() method returns.
///
/// \note If the underlying operator's transpose flag is set
/// (i.e., if UseTranspose() returns true), then EpetraPrecOp
/// will apply the transpose of the underlying operator. This
/// behavior is the same as that of the two-argument version of
/// Apply(), for the same reason as discussed in that method's
/// documentation.
///
/// \return Zero if successful, else nonzero. The value of the
/// error code is the same as would be returned by the
/// underlying operator's Apply() method.
int
ApplyInverse (const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const;
//! Return a human-readable string describing the operator.
const char* Label() const {
return "Epetra_Operator applying A^{-1} as A";
}
//! Return the current UseTranspose setting.
bool UseTranspose() const {
return Epetra_Op->UseTranspose ();
}
/// \brief If set true, the transpose of this operator will be applied.
///
/// \param UseTranspose_in [in] True if you want to apply the
/// transpose, else false. Epetra operators are real-valued,
/// never complex-valued, so applying the conjugate transpose is
/// the same as applying the transpose.
///
/// \return Zero if setting was successful, else nonzero.
///
/// This method invokes the underlying operator's
/// SetUseTranspose(). That operator returns zero if successful,
/// else nonzero. Note that SetUseTranspose() affects all
/// subsequent applications of the operator, until the next
/// SetUseTranspose() call.
int SetUseTranspose (bool UseTranspose_in) {
return Epetra_Op->SetUseTranspose (UseTranspose_in);
}
/// \brief Return true if this object can provide an approximate inf-norm.
///
/// If this method returns false, then the \c NormInf() method
/// should not be used.
bool HasNormInf () const {
return Epetra_Op->HasNormInf ();
}
/// \brief Return the infinity norm of the global matrix.
///
/// The returned value only makes sense if HasNormInf() == true.
double NormInf() const {
return Epetra_Op->NormInf ();
}
//! Return the Epetra_Comm communicator associated with this operator.
const Epetra_Comm& Comm() const { return Epetra_Op->Comm(); };
//! Return the Epetra_Map object representing the domain of this operator.
const Epetra_Map& OperatorDomainMap() const {
return Epetra_Op->OperatorDomainMap();
}
//! Return the Epetra_Map object representing the range of this operator.
const Epetra_Map& OperatorRangeMap() const {
return Epetra_Op->OperatorRangeMap();
}
private:
//! The underlying operator that this EpetraPrecOp instance wraps.
Teuchos::RCP<Epetra_Operator> Epetra_Op;
};
////////////////////////////////////////////////////////////////////
//
// Implementation of the Belos::MultiVecTraits for Epetra_MultiVector.
//
////////////////////////////////////////////////////////////////////
//! Full specialization of Belos::MultiVecTraits for Epetra_MultiVector.
template<>
class MultiVecTraits<double, Epetra_MultiVector> {
public:
/// \brief Create a new multivector with \c outNumVecs columns.
///
/// The returned Epetra_MultiVector has the same Epetra_Map
/// (distribution over one or more parallel processes) as \c mv.
/// Its entries are not initialized and have undefined values.
static Teuchos::RCP<Epetra_MultiVector>
Clone (const Epetra_MultiVector& mv, const int outNumVecs)
{
TEUCHOS_TEST_FOR_EXCEPTION(
outNumVecs <= 0, std::invalid_argument,
"Belos::MultiVecTraits<double, Epetra_MultiVector>::"
"Clone(mv, outNumVecs = " << outNumVecs << "): "
"outNumVecs must be positive.");
// NOTE (mfh 13 Jan 2011) Anasazi currently lets Epetra fill in
// the entries of the returned multivector with zeros, but Belos
// does not. We retain this different behavior for now, but the
// two versions should be reconciled.
//
// NOTE (mfh 07 Mar 2013) The Tpetra::MultiVector specialization
// of Belos::MultiVecTraits used to fill the returned
// multivector with zeros. In fact, Belos' solvers do not
// require Clone to initialize, because the Epetra_MultiVector
// specialization did not fill with zeros, and almost all of
// Belos' solvers were written to pass tests with Epetra. Thus,
// we should prefer that Clone _not_ initialize the multivector,
// because it wastes time. (We actually observed that Belos
// with Tpetra was spending a lot of time initializing
// multivectors, compared to Belos with Epetra.)
return Teuchos::rcp (new Epetra_MultiVector (mv.Map(), outNumVecs, false));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneCopy (const Epetra_MultiVector& mv)
{
return Teuchos::rcp (new Epetra_MultiVector (mv));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneCopy (const Epetra_MultiVector& mv, const std::vector<int>& index)
{
const int inNumVecs = GetNumberVecs (mv);
const int outNumVecs = index.size();
// Simple, inexpensive tests of the index vector.
TEUCHOS_TEST_FOR_EXCEPTION(outNumVecs == 0, std::invalid_argument,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneCopy(mv, index = {}): At least one vector must be"
" cloned from mv.");
if (outNumVecs > inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneCopy(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): There are " << outNumVecs
<< " indices to copy, but only " << inNumVecs << " columns of mv.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#ifdef TEUCHOS_DEBUG
// In debug mode, we perform more expensive tests of the index
// vector, to ensure all the elements are in range.
// Dereferencing the iterator is valid because index has length
// > 0.
const int minIndex = *std::min_element (index.begin(), index.end());
const int maxIndex = *std::max_element (index.begin(), index.end());
if (minIndex < 0)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneCopy(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be nonnegative, but "
"the smallest index " << minIndex << " is negative.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
if (maxIndex >= inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneCopy(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be strictly less than "
"the number of vectors " << inNumVecs << " in mv; the largest index "
<< maxIndex << " is out of bounds.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#endif // TEUCHOS_DEBUG
// Cast to nonconst, because Epetra_MultiVector's constructor
// wants a nonconst int array argument. It doesn't actually
// change the entries of the array.
std::vector<int>& tmpind = const_cast< std::vector<int>& > (index);
return Teuchos::rcp (new Epetra_MultiVector (Epetra_DataAccess::Copy, mv, &tmpind[0], index.size()));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneCopy (const Epetra_MultiVector& mv, const Teuchos::Range1D& index)
{
const int inNumVecs = GetNumberVecs (mv);
const int outNumVecs = index.size();
const bool validRange = outNumVecs > 0 && index.lbound() >= 0 &&
index.ubound() < inNumVecs;
if (! validRange)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::Clone(mv,"
"index=[" << index.lbound() << ", " << index.ubound() << "]): ";
TEUCHOS_TEST_FOR_EXCEPTION(outNumVecs == 0, std::invalid_argument,
os.str() << "Column index range must be nonempty.");
TEUCHOS_TEST_FOR_EXCEPTION(index.lbound() < 0, std::invalid_argument,
os.str() << "Column index range must be nonnegative.");
TEUCHOS_TEST_FOR_EXCEPTION(index.ubound() >= inNumVecs, std::invalid_argument,
os.str() << "Column index range must not exceed "
"number of vectors " << inNumVecs << " in the "
"input multivector.");
}
return Teuchos::rcp (new Epetra_MultiVector (Epetra_DataAccess::Copy, mv, index.lbound(), index.size()));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneViewNonConst (Epetra_MultiVector& mv, const std::vector<int>& index)
{
const int inNumVecs = GetNumberVecs (mv);
const int outNumVecs = index.size();
// Simple, inexpensive tests of the index vector.
TEUCHOS_TEST_FOR_EXCEPTION(outNumVecs == 0, std::invalid_argument,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneViewNonConst(mv, index = {}): The output view "
"must have at least one column.");
if (outNumVecs > inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneViewNonConst(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): There are " << outNumVecs
<< " indices to view, but only " << inNumVecs << " columns of mv.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#ifdef TEUCHOS_DEBUG
// In debug mode, we perform more expensive tests of the index
// vector, to ensure all the elements are in range.
// Dereferencing the iterator is valid because index has length
// > 0.
const int minIndex = *std::min_element (index.begin(), index.end());
const int maxIndex = *std::max_element (index.begin(), index.end());
if (minIndex < 0)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneViewNonConst(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be nonnegative, but "
"the smallest index " << minIndex << " is negative.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
if (maxIndex >= inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneViewNonConst(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be strictly less than "
"the number of vectors " << inNumVecs << " in mv; the largest index "
<< maxIndex << " is out of bounds.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#endif // TEUCHOS_DEBUG
// Cast to nonconst, because Epetra_MultiVector's constructor
// wants a nonconst int array argument. It doesn't actually
// change the entries of the array.
std::vector<int>& tmpind = const_cast< std::vector<int>& > (index);
return Teuchos::rcp (new Epetra_MultiVector (Epetra_DataAccess::View, mv, &tmpind[0], index.size()));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneViewNonConst (Epetra_MultiVector& mv, const Teuchos::Range1D& index)
{
const bool validRange = index.size() > 0 &&
index.lbound() >= 0 &&
index.ubound() < mv.NumVectors();
if (! validRange)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::CloneView"
"NonConst(mv,index=[" << index.lbound() << ", " << index.ubound()
<< "]): ";
TEUCHOS_TEST_FOR_EXCEPTION(index.size() == 0, std::invalid_argument,
os.str() << "Column index range must be nonempty.");
TEUCHOS_TEST_FOR_EXCEPTION(index.lbound() < 0, std::invalid_argument,
os.str() << "Column index range must be nonnegative.");
TEUCHOS_TEST_FOR_EXCEPTION(index.ubound() >= mv.NumVectors(),
std::invalid_argument,
os.str() << "Column index range must not exceed "
"number of vectors " << mv.NumVectors() << " in "
"the input multivector.");
}
return Teuchos::rcp (new Epetra_MultiVector (Epetra_DataAccess::View, mv, index.lbound(), index.size()));
}
static Teuchos::RCP<const Epetra_MultiVector>
CloneView (const Epetra_MultiVector& mv, const std::vector<int>& index)
{
const int inNumVecs = GetNumberVecs (mv);
const int outNumVecs = index.size();
// Simple, inexpensive tests of the index vector.
TEUCHOS_TEST_FOR_EXCEPTION(outNumVecs == 0, std::invalid_argument,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneView(mv, index = {}): The output view "
"must have at least one column.");
if (outNumVecs > inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneView(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): There are " << outNumVecs
<< " indices to view, but only " << inNumVecs << " columns of mv.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#ifdef TEUCHOS_DEBUG
// In debug mode, we perform more expensive tests of the index
// vector, to ensure all the elements are in range.
// Dereferencing the iterator is valid because index has length
// > 0.
const int minIndex = *std::min_element (index.begin(), index.end());
const int maxIndex = *std::max_element (index.begin(), index.end());
if (minIndex < 0)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneView(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be nonnegative, but "
"the smallest index " << minIndex << " is negative.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
if (maxIndex >= inNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"CloneView(mv, index = {";
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1] << "}): Indices must be strictly less than "
"the number of vectors " << inNumVecs << " in mv; the largest index "
<< maxIndex << " is out of bounds.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
#endif // TEUCHOS_DEBUG
// Cast to nonconst, because Epetra_MultiVector's constructor
// wants a nonconst int array argument. It doesn't actually
// change the entries of the array.
std::vector<int>& tmpind = const_cast< std::vector<int>& > (index);
return Teuchos::rcp (new Epetra_MultiVector (Epetra_DataAccess::View, mv, &tmpind[0], index.size()));
}
static Teuchos::RCP<Epetra_MultiVector>
CloneView (const Epetra_MultiVector& mv, const Teuchos::Range1D& index)
{
const bool validRange = index.size() > 0 &&
index.lbound() >= 0 &&
index.ubound() < mv.NumVectors();
if (! validRange)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::CloneView"
"(mv,index=[" << index.lbound() << ", " << index.ubound()
<< "]): ";
TEUCHOS_TEST_FOR_EXCEPTION(index.size() == 0, std::invalid_argument,
os.str() << "Column index range must be nonempty.");
TEUCHOS_TEST_FOR_EXCEPTION(index.lbound() < 0, std::invalid_argument,
os.str() << "Column index range must be nonnegative.");
TEUCHOS_TEST_FOR_EXCEPTION(index.ubound() >= mv.NumVectors(),
std::invalid_argument,
os.str() << "Column index range must not exceed "
"number of vectors " << mv.NumVectors() << " in "
"the input multivector.");
}
return Teuchos::rcp (new Epetra_MultiVector(Epetra_DataAccess::View, mv, index.lbound(), index.size()));
}
static ptrdiff_t GetGlobalLength( const Epetra_MultiVector& mv )
{
if (mv.Map().GlobalIndicesLongLong())
return static_cast<ptrdiff_t>( mv.GlobalLength64() );
else
return static_cast<ptrdiff_t>( mv.GlobalLength() );
}
static int GetNumberVecs( const Epetra_MultiVector& mv )
{ return mv.NumVectors(); }
static bool HasConstantStride( const Epetra_MultiVector& mv )
{ return mv.ConstantStride(); }
static void
MvTimesMatAddMv (const double alpha,
const Epetra_MultiVector& A,
const Teuchos::SerialDenseMatrix<int,double>& B,
const double beta,
Epetra_MultiVector& mv)
{
Epetra_LocalMap LocalMap(B.numRows(), 0, mv.Map().Comm());
Epetra_MultiVector B_Pvec(Epetra_DataAccess::View, LocalMap, B.values(), B.stride(), B.numCols());
const int info = mv.Multiply ('N', 'N', alpha, A, B_Pvec, beta);
TEUCHOS_TEST_FOR_EXCEPTION(
info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvTimesMatAddMv: "
"Epetra_MultiVector::Multiply() returned a nonzero value info=" << info
<< ".");
}
/// \brief <tt>mv := alpha*A + beta*B</tt>
///
/// The Epetra specialization of this method ignores and
/// completely overwrites any NaN or Inf entries in A. Thus, it
/// does <i>not</i> mean the same thing as <tt>mv := 0*mv +
/// alpha*A + beta*B</tt> in IEEE 754 floating-point arithmetic.
/// (Remember that NaN*0 = NaN.)
static void
MvAddMv (const double alpha,
const Epetra_MultiVector& A,
const double beta,
const Epetra_MultiVector& B,
Epetra_MultiVector& mv)
{
const int info = mv.Update (alpha, A, beta, B, 0.0);
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double, Epetra_MultiVector>::MvAddMv: Call to "
"Update() returned a nonzero value " << info << ".");
}
static void
MvScale (Epetra_MultiVector& mv,
const double alpha)
{
const int info = mv.Scale (alpha);
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvScale: "
"Epetra_MultiVector::Scale() returned a nonzero value info="
<< info << ".");
}
//! For all columns j of \c mv, set <tt>mv[j] := alpha[j] * mv[j]</tt>.
static void
MvScale (Epetra_MultiVector& mv,
const std::vector<double>& alpha)
{
// Check to make sure the vector has the same number of entries
// as the multivector has columns.
const int numvecs = mv.NumVectors ();
TEUCHOS_TEST_FOR_EXCEPTION(
(int) alpha.size () != numvecs, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvScale: "
"Array alpha of scaling coefficients has " << alpha.size ()
<< " entries, which is not the same as the number of columns "
<< numvecs << " in the input multivector mv.");
int info = 0;
std::vector<int> tmp_index (1, 0);
for (int i = 0; i < numvecs; ++i) {
Epetra_MultiVector temp_vec (Epetra_DataAccess::View, mv, &tmp_index[0], 1);
info = temp_vec.Scale (alpha[i]);
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvScale: "
"On column " << (i+1) << " of " << numvecs << ", Epetra_Multi"
"Vector::Scale() returned a nonzero value info=" << info << ".");
tmp_index[0]++;
}
}
//! <tt>B := alpha * A^T * mv</tt>.
static void MvTransMv( const double alpha, const Epetra_MultiVector& A, const Epetra_MultiVector& mv, Teuchos::SerialDenseMatrix<int,double>& B )
{
Epetra_LocalMap LocalMap(B.numRows(), 0, mv.Map().Comm());
Epetra_MultiVector B_Pvec(Epetra_DataAccess::View, LocalMap, B.values(), B.stride(), B.numCols());
const int info = B_Pvec.Multiply ('T', 'N', alpha, A, mv, 0.0);
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvTransMv: "
"Epetra_MultiVector::Multiply() returned a nonzero value info="
<< info << ".");
}
//! For all columns j of mv, set <tt>b[j] := mv[j]^T * A[j]</tt>.
static void
MvDot (const Epetra_MultiVector& mv,
const Epetra_MultiVector& A,
std::vector<double>& b)
{
const int info = mv.Dot (A, &b[0]);
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvDot: "
"Epetra_MultiVector::Dot() returned a nonzero value info="
<< info << ".");
}
//! For all columns j of mv, set <tt>normvec[j] = norm(mv[j])</tt>.
static void
MvNorm (const Epetra_MultiVector& mv,
std::vector<double>& normvec,
NormType type = TwoNorm)
{
if ((int)normvec.size() >= mv.NumVectors()) {
int info = 0;
switch( type ) {
case ( OneNorm ) :
info = mv.Norm1(&normvec[0]);
break;
case ( TwoNorm ) :
info = mv.Norm2(&normvec[0]);
break;
case ( InfNorm ) :
info = mv.NormInf(&normvec[0]);
break;
default:
break;
}
TEUCHOS_TEST_FOR_EXCEPTION(info != 0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::MvNorm: "
"Epetra_MultiVector::Norm() returned a nonzero value info="
<< info << ".");
}
}
static void
SetBlock (const Epetra_MultiVector& A,
const std::vector<int>& index,
Epetra_MultiVector& mv)
{
const int inNumVecs = GetNumberVecs (A);
const int outNumVecs = index.size();
// NOTE (mfh 13 Jan 2011) Belos allows A to have more columns
// than index.size(), in which case we just take the first
// index.size() columns of A. Anasazi requires that A have the
// same number of columns as index.size(). Changing Anasazi's
// behavior should not break existing Anasazi solvers, but the
// tests need to be done.
if (inNumVecs < outNumVecs)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"SetBlock(A, mv, index = {";
if (outNumVecs > 0)
{
for (int k = 0; k < outNumVecs - 1; ++k)
os << index[k] << ", ";
os << index[outNumVecs-1];
}
os << "}): A has only " << inNumVecs << " columns, but there are "
<< outNumVecs << " indices in the index vector.";
TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, os.str());
}
// Make a view of the columns of mv indicated by the index std::vector.
Teuchos::RCP<Epetra_MultiVector> mv_view = CloneViewNonConst (mv, index);
// View of columns [0, outNumVecs-1] of the source multivector A.
// If A has fewer columns than mv_view, then create a view of
// the first outNumVecs columns of A.
Teuchos::RCP<const Epetra_MultiVector> A_view;
if (outNumVecs == inNumVecs)
A_view = Teuchos::rcpFromRef (A); // Const, non-owning RCP
else
A_view = CloneView (A, Teuchos::Range1D(0, outNumVecs - 1));
// Assignment calls Epetra_MultiVector::Assign(), which deeply
// copies the data directly, ignoring the underlying
// Epetra_Map(s). If A and mv don't have the same data
// distribution (Epetra_Map), this may result in incorrect or
// undefined behavior. Epetra_MultiVector::Update() also
// ignores the Epetra_Maps, so we might as well just use the
// (perhaps slightly cheaper) Assign() method via operator=().
*mv_view = *A_view;
}
static void
SetBlock (const Epetra_MultiVector& A,
const Teuchos::Range1D& index,
Epetra_MultiVector& mv)
{
const int numColsA = A.NumVectors();
const int numColsMv = mv.NumVectors();
// 'index' indexes into mv; it's the index set of the target.
const bool validIndex = index.lbound() >= 0 && index.ubound() < numColsMv;
// We can't take more columns out of A than A has.
const bool validSource = index.size() <= numColsA;
if (! validIndex || ! validSource)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double, Epetra_MultiVector>::SetBlock"
"(A, index=[" << index.lbound() << ", " << index.ubound() << "], "
"mv): ";
TEUCHOS_TEST_FOR_EXCEPTION(index.lbound() < 0, std::invalid_argument,
os.str() << "Range lower bound must be nonnegative.");
TEUCHOS_TEST_FOR_EXCEPTION(index.ubound() >= numColsMv, std::invalid_argument,
os.str() << "Range upper bound must be less than "
"the number of columns " << numColsA << " in the "
"'mv' output argument.");
TEUCHOS_TEST_FOR_EXCEPTION(index.size() > numColsA, std::invalid_argument,
os.str() << "Range must have no more elements than"
" the number of columns " << numColsA << " in the "
"'A' input argument.");
TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error, "Should never get here!");
}
// View of columns [index.lbound(), index.ubound()] of the
// target multivector mv. We avoid view creation overhead by
// only creating a view if the index range is different than [0,
// (# columns in mv) - 1].
Teuchos::RCP<Epetra_MultiVector> mv_view;
if (index.lbound() == 0 && index.ubound()+1 == numColsMv)
mv_view = Teuchos::rcpFromRef (mv); // Non-const, non-owning RCP
else
mv_view = CloneViewNonConst (mv, index);
// View of columns [0, index.size()-1] of the source multivector
// A. If A has fewer columns than mv_view, then create a view
// of the first index.size() columns of A.
Teuchos::RCP<const Epetra_MultiVector> A_view;
if (index.size() == numColsA)
A_view = Teuchos::rcpFromRef (A); // Const, non-owning RCP
else
A_view = CloneView (A, Teuchos::Range1D(0, index.size()-1));
// Assignment calls Epetra_MultiVector::Assign(), which deeply
// copies the data directly, ignoring the underlying
// Epetra_Map(s). If A and mv don't have the same data
// distribution (Epetra_Map), this may result in incorrect or
// undefined behavior. Epetra_MultiVector::Update() also
// ignores the Epetra_Maps, so we might as well just use the
// (perhaps slightly cheaper) Assign() method via operator=().
*mv_view = *A_view;
}
static void
Assign (const Epetra_MultiVector& A,
Epetra_MultiVector& mv)
{
const int numColsA = GetNumberVecs (A);
const int numColsMv = GetNumberVecs (mv);
if (numColsA > numColsMv)
{
std::ostringstream os;
os << "Belos::MultiVecTraits<double, Epetra_MultiVector>::Assign"
"(A, mv): ";
TEUCHOS_TEST_FOR_EXCEPTION(numColsA > numColsMv, std::invalid_argument,
os.str() << "Input multivector 'A' has "
<< numColsA << " columns, but output multivector "
"'mv' has only " << numColsMv << " columns.");
TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error, "Should never get here!");
}
// View of the first [0, numColsA-1] columns of mv.
Teuchos::RCP<Epetra_MultiVector> mv_view;
if (numColsMv == numColsA)
mv_view = Teuchos::rcpFromRef (mv); // Non-const, non-owning RCP
else // numColsMv > numColsA
mv_view = CloneView (mv, Teuchos::Range1D(0, numColsA - 1));
// Assignment calls Epetra_MultiVector::Assign(), which deeply
// copies the data directly, ignoring the underlying
// Epetra_Map(s). If A and mv don't have the same data
// distribution (Epetra_Map), this may result in incorrect or
// undefined behavior. Epetra_MultiVector::Update() also
// ignores the Epetra_Maps, so we might as well just use the
// (perhaps slightly cheaper) Assign() method via operator=().
*mv_view = A;
}
static void MvRandom (Epetra_MultiVector& mv)
{
TEUCHOS_TEST_FOR_EXCEPTION( mv.Random()!=0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"MvRandom() call to Random() returned a nonzero value.");
}
static void MvInit (Epetra_MultiVector& mv,
double alpha = Teuchos::ScalarTraits<double>::zero())
{
TEUCHOS_TEST_FOR_EXCEPTION( mv.PutScalar(alpha)!=0, EpetraMultiVecFailure,
"Belos::MultiVecTraits<double,Epetra_MultiVector>::"
"MvInit() call to PutScalar() returned a nonzero value.");
}
static void MvPrint (const Epetra_MultiVector& mv, std::ostream& os)
{
os << mv << std::endl;
}
#ifdef HAVE_BELOS_TSQR
/// \typedef tsqr_adaptor_type
/// \brief TsqrAdaptor specialization for Epetra_MultiVector
///
typedef Epetra::TsqrAdaptor tsqr_adaptor_type;
#endif // HAVE_BELOS_TSQR
};
////////////////////////////////////////////////////////////////////
//
// Implementation of the Belos::OperatorTraits for Epetra_Operator.
//
////////////////////////////////////////////////////////////////////
//! Specialization of OperatorTraits for Epetra_Operator.
template <>
class OperatorTraits <double, Epetra_MultiVector, Epetra_Operator>
{
public:
/// \brief Specialization of Apply() for Epetra_Operator.
///
/// This method throws an EpetraOpFailure on failure. It fails in
/// either of the following two cases:
/// 1. If the operator's Epetra_Operator::Apply() method fails
/// (which it indicates by returning a nonzero value).
/// 2. If you attempt to apply the transpose and the underlying
/// operator does not implement the transpose.
///
/// Epetra_Operator objects have a "persistent" transpose state,
/// which means that the input Op might already be set to use the
/// transpose. We assume in that case that trans=NOTRANS means
/// don't apply the transpose, and trans=TRANS means apply the
/// transpose (not the "transpose of the transpose"). Thus, trans
/// has its literal meaning. However, we leave Op on exit of this
/// routine with the same transpose setting that it had on entry.
///
/// \note If you want to implement an operator that applies the
/// transpose to an existing operator A in a reversed sense
/// (i.e., "transposed" means not transposed, and "not
/// transposed" means transposed), you should write a class
/// implementing Epetra_Operator that wraps A. This class
/// should implement `Epetra_Operator::UseTranspose()` by
/// returning `!(A->UseTranspose())`, and should implement
/// `Epetra_Operator::SetUseTranspose(useTrans)` by calling
/// `A->SetUseTranspose(!useTrans)`.
static void
Apply (const Epetra_Operator& Op,
const Epetra_MultiVector& x,
Epetra_MultiVector& y,
ETrans trans=NOTRANS);
//! Whether Op implements applying the transpose.
static bool
HasApplyTranspose (const Epetra_Operator& Op);
};
} // end of Belos namespace
#endif
// end of file BELOS_EPETRA_ADAPTER_HPP
|