/usr/include/trilinos/BelosMueLuAdapter.hpp is in libtrilinos-muelu-dev 12.4.2-2.
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 | // @HEADER
//
// ***********************************************************************
//
// MueLu: A package for multigrid based preconditioning
// 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 BELOS_MUELU_ADAPTER_HPP
#define BELOS_MUELU_ADAPTER_HPP
#ifdef HAVE_MUELU_EPETRA
#include <BelosOperator.hpp>
#endif
#ifdef HAVE_MUELU_AMGX
#include "MueLu_AMGXOperator.hpp"
#endif
#include <BelosOperatorT.hpp>
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_Hierarchy.hpp"
namespace Belos {
using Teuchos::RCP;
using Teuchos::rcpFromRef;
//
//! @name MueLu Adapter Exceptions
//@{
/** \brief MueLuOpFailure is thrown when a return value from an MueLu
* call on an Xpetra::Operator or MueLu::Hierarchy is non-zero.
*/
class MueLuOpFailure : public BelosError {public:
MueLuOpFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
//TODO: doc
template <class Scalar,
class LocalOrdinal = int,
class GlobalOrdinal = LocalOrdinal,
class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLuOp :
public OperatorT<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
#ifdef HAVE_MUELU_TPETRA
, public OperatorT<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
#endif
{
public:
//! @name Constructor/Destructor
//@{
//! Default constructor
MueLuOp(const RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> >&H) : Hierarchy_(H) {}
#ifdef HAVE_MUELU_AMGX
MueLuOp(const RCP<MueLu::AMGXOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& A) : AMGX_(A) {}
#endif
//! Destructor.
virtual ~MueLuOp() {}
//@}
//! @name Operator application method
//@{
/*! \brief This routine takes the Xpetra::MultiVector \c x and applies the operator
to it resulting in the Xpetra::MultiVector \c y, which is returned.
\note It is expected that any problem with applying this operator to \c x will be
indicated by an std::exception being thrown.
*/
void Apply(const Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x, Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& y, ETrans trans = NOTRANS ) const {
TEUCHOS_TEST_FOR_EXCEPTION(trans!=NOTRANS, MueLuOpFailure,
"Belos::MueLuOp::Apply, transpose mode != NOTRANS not supported by MueLu preconditionners.");
// This does not matter for Hierarchy, but matters for AMGX
y.putScalar(0.0);
#ifdef HAVE_MUELU_AMGX
if (!AMGX_.is_null()) {
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tX = Xpetra::toTpetra(x);
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tY = Xpetra::toTpetra(y);
AMGX_->apply(tX, tY);
}
#endif
if (!Hierarchy_.is_null())
Hierarchy_->Iterate(x, y, 1, true);
}
#ifdef HAVE_MUELU_TPETRA
// TO SKIP THE TRAIT IMPLEMENTATION OF XPETRA::MULTIVECTOR
/*! \brief This routine takes the Tpetra::MultiVector \c x and applies the operator
to it resulting in the Tpetra::MultiVector \c y, which is returned.
\note It is expected that any problem with applying this operator to \c x will be
indicated by an std::exception being thrown.
*/
void Apply(const Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x, Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& y, ETrans trans = NOTRANS ) const {
TEUCHOS_TEST_FOR_EXCEPTION(trans!=NOTRANS, MueLuOpFailure,
"Belos::MueLuOp::Apply, transpose mode != NOTRANS not supported by MueLu preconditionners.");
//FIXME InitialGuessIsZero currently does nothing in MueLu::Hierarchy.Iterate(), but it matters for AMGX
y.putScalar(0.0);
#ifdef HAVE_MUELU_AMGX
if (!AMGX_.is_null())
AMGX_->apply(x, y);
#endif
if (!Hierarchy_.is_null()) {
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & temp_x = const_cast<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &>(x);
const Xpetra::TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tX(rcpFromRef(temp_x));
Xpetra::TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tY(rcpFromRef(y));
Hierarchy_->Iterate(tX, tY, 1, true);
}
}
#endif
private:
RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Hierarchy_;
#ifdef HAVE_MUELU_AMGX
RCP<MueLu::AMGXOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > AMGX_;
#endif
};
template <>
class MueLuOp<double, int, int> :
public OperatorT<Xpetra::MultiVector<double, int, int> >
#ifdef HAVE_MUELU_TPETRA
, public OperatorT<Tpetra::MultiVector<double, int, int> >
#endif
#ifdef HAVE_MUELU_EPETRA
, public OperatorT<Epetra_MultiVector>
, public Belos::Operator<double>
#endif
{
typedef double Scalar;
typedef int LocalOrdinal;
typedef int GlobalOrdinal;
typedef Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type Node;
public:
MueLuOp(const RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& H) : Hierarchy_(H) {}
#ifdef HAVE_MUELU_AMGX
MueLuOp(const RCP<MueLu::AMGXOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& A) : AMGX_(A) {}
#endif
virtual ~MueLuOp() {}
void Apply(const Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x, Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& y, ETrans trans = NOTRANS ) const {
TEUCHOS_TEST_FOR_EXCEPTION(trans != NOTRANS, MueLuOpFailure,
"Belos::MueLuOp::Apply, transpose mode != NOTRANS not supported by MueLu preconditionners.");
//FIXME InitialGuessIsZero currently does nothing in MueLu::Hierarchy.Iterate(), but it matters for AMGX
y.putScalar(0.0);
#ifdef HAVE_MUELU_AMGX
if (!AMGX_.is_null()) {
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tX = Xpetra::toTpetra(x);
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tY = Xpetra::toTpetra(y);
AMGX_->apply(tX, tY);
}
#endif
if (!Hierarchy_.is_null())
Hierarchy_->Iterate(x, y, 1, true);
}
#ifdef HAVE_MUELU_TPETRA
void Apply ( const Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x, Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& y, ETrans trans=NOTRANS ) const {
TEUCHOS_TEST_FOR_EXCEPTION(trans != NOTRANS, MueLuOpFailure,
"Belos::MueLuOp::Apply, transpose mode != NOTRANS not supported by MueLu preconditionners.");
//FIXME InitialGuessIsZero currently does nothing in MueLu::Hierarchy.Iterate(), but it matters for AMGX
y.putScalar(0.0);
#ifdef HAVE_MUELU_AMGX
if (!AMGX_.is_null())
AMGX_->apply(x, y);
#endif
if (!Hierarchy_.is_null()) {
Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & temp_x = const_cast<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &>(x);
const Xpetra::TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tX(rcpFromRef(temp_x));
Xpetra::TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> tY(rcpFromRef(y));
tY.putScalar(0.0);
Hierarchy_->Iterate(tX, tY, 1, true);
}
}
#endif
#ifdef HAVE_MUELU_EPETRA
// TO SKIP THE TRAIT IMPLEMENTATION OF XPETRA::MULTIVECTOR
/*! \brief This routine takes the Tpetra::MultiVector \c x and applies the operator
to it resulting in the Tpetra::MultiVector \c y, which is returned.
\note It is expected that any problem with applying this operator to \c x will be
indicated by an std::exception being thrown.
*/
void Apply(const Epetra_MultiVector& x, Epetra_MultiVector& y, ETrans trans = NOTRANS) const {
TEUCHOS_TEST_FOR_EXCEPTION(trans != NOTRANS, MueLuOpFailure,
"Belos::MueLuOp::Apply, transpose mode != NOTRANS not supported by MueLu preconditionners.");
Epetra_MultiVector& temp_x = const_cast<Epetra_MultiVector&>(x);
const Xpetra::EpetraMultiVector tX(rcpFromRef(temp_x));
Xpetra::EpetraMultiVector tY(rcpFromRef(y));
//FIXME InitialGuessIsZero currently does nothing in MueLu::Hierarchy.Iterate().
tY.putScalar(0.0);
Hierarchy_->Iterate(tX, tY, 1, true);
}
/*! \brief This routine takes the Belos::MultiVec \c x and applies the operator
to it resulting in the Belos::MultiVec \c y, which is returned.
\note It is expected that any problem with applying this operator to \c x will be
indicated by an std::exception being thrown.
*/
void Apply(const Belos::MultiVec<double>& x, Belos::MultiVec<double>& y, ETrans trans = NOTRANS ) const {
const Epetra_MultiVector* vec_x = dynamic_cast<const Epetra_MultiVector*>(&x);
Epetra_MultiVector* vec_y = dynamic_cast<Epetra_MultiVector*>(&y);
TEUCHOS_TEST_FOR_EXCEPTION(vec_x==NULL || vec_y==NULL, MueLuOpFailure,
"Belos::MueLuOp::Apply, x and/or y cannot be dynamic cast to an Epetra_MultiVector.");
Apply(*vec_x, *vec_y, trans);
}
#endif
private:
RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Hierarchy_;
#ifdef HAVE_MUELU_AMGX
RCP<MueLu::AMGXOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > AMGX_;
#endif
};
} // namespace Belos
#endif // BELOS_MUELU_ADAPTER_HPP
|