/usr/include/trilinos/MueLu_CreateEpetraPreconditioner.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 | #ifndef MUELU_CREATE_EPETRA_PRECONDITIONER_HPP
#define MUELU_CREATE_EPETRA_PRECONDITIONER_HPP
#include <Teuchos_XMLParameterListHelpers.hpp>
#include <Xpetra_CrsMatrix.hpp>
#include <Xpetra_MultiVector.hpp>
#include <Xpetra_MultiVectorFactory.hpp>
#include <MueLu.hpp>
#include <MueLu_EpetraOperator.hpp>
#include <MueLu_Exceptions.hpp>
#include <MueLu_Hierarchy.hpp>
#include <MueLu_MasterList.hpp>
#include <MueLu_MLParameterListInterpreter.hpp>
#include <MueLu_ParameterListInterpreter.hpp>
#include <MueLu_Utilities.hpp>
#include <MueLu_HierarchyHelpers.hpp>
//! @file
//! @brief Various adapters that will create a MueLu preconditioner that is an Epetra_Operator.
namespace MueLu {
/*!
@brief Helper function to create a MueLu preconditioner that can be used by Epetra.
@ingroup MueLuAdapters
Given a EpetraCrs_Matrix, this function returns a constructed MueLu preconditioner.
@param[in] inA Matrix
@param[in] paramListIn Parameter list
@param[in] inCoords (optional) Coordinates. The first vector is x, the second (if necessary) y, the third (if necessary) z.
@param[in] inNullspace (optional) Near nullspace of the matrix.
*/
Teuchos::RCP<MueLu::EpetraOperator>
CreateEpetraPreconditioner(const Teuchos::RCP<Epetra_CrsMatrix>& inA,
// FIXME: why is it non-const
Teuchos::ParameterList& paramListIn,
const Teuchos::RCP<Epetra_MultiVector>& inCoords = Teuchos::null,
const Teuchos::RCP<Epetra_MultiVector>& inNullspace = Teuchos::null)
{
typedef double SC;
typedef int LO;
typedef int GO;
typedef KokkosClassic::DefaultNode::DefaultNodeType NO;
using Teuchos::ParameterList;
typedef Xpetra::MultiVector<SC, LO, GO, NO> MultiVector;
typedef Xpetra::Matrix<SC, LO, GO, NO> Matrix;
typedef Hierarchy<SC,LO,GO,NO> Hierarchy;
typedef HierarchyManager<SC,LO,GO,NO> HierarchyManager;
bool hasParamList = paramListIn.numParams();
RCP<HierarchyManager> mueLuFactory;
ParameterList paramList = paramListIn;
std::string syntaxStr = "parameterlist: syntax";
if (hasParamList && paramList.isParameter(syntaxStr) && paramList.get<std::string>(syntaxStr) == "ml") {
paramList.remove(syntaxStr);
mueLuFactory = rcp(new MLParameterListInterpreter<SC,LO,GO,NO>(paramList));
} else {
mueLuFactory = rcp(new ParameterListInterpreter <SC,LO,GO,NO>(paramList,Xpetra::toXpetra(inA->Comm())));
}
RCP<Hierarchy> H = mueLuFactory->CreateHierarchy();
H->setlib(Xpetra::UseEpetra);
// Wrap A
RCP<Matrix> A = EpetraCrs_To_XpetraMatrix<SC, LO, GO, NO>(inA);
H->GetLevel(0)->Set("A", A);
// Wrap coordinates if available
if (inCoords != Teuchos::null) {
RCP<MultiVector> coordinates = EpetraMultiVector_To_XpetraMultiVector<SC,LO,GO,NO>(inCoords);
H->GetLevel(0)->Set("Coordinates", coordinates);
}
// Wrap nullspace if available, otherwise use constants
RCP<MultiVector> nullspace;
if (inNullspace != Teuchos::null) {
nullspace = EpetraMultiVector_To_XpetraMultiVector<SC, LO, GO, NO>(inNullspace);
} else {
int nPDE = MasterList::getDefault<int>("number of equations");
if (paramList.isSublist("Matrix")) {
// Factory style parameter list
const Teuchos::ParameterList& operatorList = paramList.sublist("Matrix");
if (operatorList.isParameter("PDE equations"))
nPDE = operatorList.get<int>("PDE equations");
} else if (paramList.isParameter("number of equations")) {
// Easy style parameter list
nPDE = paramList.get<int>("number of equations");
}
nullspace = Xpetra::MultiVectorFactory<SC,LO,GO,NO>::Build(A->getDomainMap(), nPDE);
if (nPDE == 1) {
nullspace->putScalar(Teuchos::ScalarTraits<SC>::one());
} else {
for (int i = 0; i < nPDE; i++) {
Teuchos::ArrayRCP<SC> nsData = nullspace->getDataNonConst(i);
for (int j = 0; j < nsData.size(); j++) {
GO GID = A->getDomainMap()->getGlobalElement(j) - A->getDomainMap()->getIndexBase();
if ((GID-i) % nPDE == 0)
nsData[j] = Teuchos::ScalarTraits<SC>::one();
}
}
}
}
H->GetLevel(0)->Set("Nullspace", nullspace);
Teuchos::ParameterList nonSerialList,dummyList;
ExtractNonSerializableData(paramList, dummyList, nonSerialList);
HierarchyUtils<SC,LO,GO,NO>::AddNonSerializableDataToHierarchy(*mueLuFactory,*H, nonSerialList);
mueLuFactory->SetupHierarchy(*H);
return rcp(new EpetraOperator(H));
}
/*!
@brief Helper function to create a MueLu preconditioner that can be used by Epetra.
@ingroup MueLuAdapters
Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner.
@param[in] inA Matrix
@param[in] inCoords (optional) Coordinates. The first vector is x, the second (if necessary) y, the third (if necessary) z.
@param[in] inNullspace (optional) Near nullspace of the matrix.
*/
Teuchos::RCP<MueLu::EpetraOperator>
CreateEpetraPreconditioner(const Teuchos::RCP<Epetra_CrsMatrix> & inA,
const Teuchos::RCP<Epetra_MultiVector>& inCoords = Teuchos::null,
const Teuchos::RCP<Epetra_MultiVector>& inNullspace = Teuchos::null) {
Teuchos::ParameterList paramList;
return CreateEpetraPreconditioner(inA, paramList, inCoords, inNullspace);
}
/*!
@brief Helper function to create a MueLu preconditioner that can be used by Epetra.
@ingroup MueLuAdapters
Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner.
@param[in] inA Matrix
@param[in] xmlFileName XML file containing MueLu options
@param[in] inCoords (optional) Coordinates. The first vector is x, the second (if necessary) y, the third (if necessary) z.
@param[in] inNullspace (optional) Near nullspace of the matrix.
*/
Teuchos::RCP<MueLu::EpetraOperator>
CreateEpetraPreconditioner(const Teuchos::RCP<Epetra_CrsMatrix> & A,
const std::string& xmlFileName,
const Teuchos::RCP<Epetra_MultiVector>& inCoords = Teuchos::null,
const Teuchos::RCP<Epetra_MultiVector>& inNullspace = Teuchos::null)
{
Teuchos::ParameterList paramList;
Teuchos::updateParametersFromXmlFileAndBroadcast(xmlFileName, Teuchos::Ptr<Teuchos::ParameterList>(¶mList), *Xpetra::toXpetra(A->Comm()));
return CreateEpetraPreconditioner(A, paramList, inCoords, inNullspace);
}
void ReuseEpetraPreconditioner(const Teuchos::RCP<Epetra_CrsMatrix>& inA, MueLu::EpetraOperator& Op) {
typedef double SC;
typedef int LO;
typedef int GO;
typedef KokkosClassic::DefaultNode::DefaultNodeType NO;
typedef Xpetra::Matrix<SC,LO,GO,NO> Matrix;
typedef Xpetra::Operator<SC,LO,GO,NO> Operator;
typedef MueLu ::Hierarchy<SC,LO,GO,NO> Hierarchy;
RCP<Hierarchy> H = Op.GetHierarchy();
TEUCHOS_TEST_FOR_EXCEPTION(!H->GetNumLevels(), Exceptions::RuntimeError,
"ReuseTpetraPreconditioner: Hierarchy has no levels in it");
TEUCHOS_TEST_FOR_EXCEPTION(!H->GetLevel(0)->IsAvailable("A"), Exceptions::RuntimeError,
"ReuseTpetraPreconditioner: Hierarchy has no fine level operator");
RCP<Level> level0 = H->GetLevel(0);
RCP<Operator> O0 = level0->Get<RCP<Operator> >("A");
RCP<Matrix> A0 = Teuchos::rcp_dynamic_cast<Matrix>(O0);
RCP<Matrix> A = EpetraCrs_To_XpetraMatrix<SC,LO,GO,NO>(inA);
if (!A0.is_null()) {
// If a user provided a "number of equations" argument in a parameter list
// during the initial setup, we must honor that settings and reuse it for
// all consequent setups.
A->SetFixedBlockSize(A0->GetFixedBlockSize());
}
level0->Set("A", A);
H->SetupRe();
}
} //namespace
#endif //ifndef MUELU_CREATE_EPETRA_PRECONDITIONER_HPP
|