MueLu  Version of the Day
List of all members
MueLu::ML2MueLuParameterTranslator Class Reference

Class that accepts ML-style parameters and builds a MueLu parameter list (easy input deck) More...

#include <MueLu_ML2MueLuParameterTranslator.hpp>

Constructors/Destructors.

 ML2MueLuParameterTranslator ()
 Constructor. More...
 
virtual ~ML2MueLuParameterTranslator ()
 Destructor. More...
 

Parameter translation from ML to MueLu

static std::string translate (Teuchos::ParameterList &paramList, const std::string &defaultVals="")
 : Translate ML parameters to MueLu parameter XML string More...
 
static std::string translate (const std::string &xmlFileName, const std::string &defaultVals="")
 : Translate ML parameters to MueLu parameter XML string More...
 

Parameter handling

static std::string SetParameterList (const Teuchos::ParameterList &paramList_in, const std::string &defaultVals)
 : Interpret parameter list More...
 
static std::string GetSmootherFactory (const Teuchos::ParameterList &paramList, Teuchos::ParameterList &adaptingParamList, const std::string &pname, const std::string &value)
 : Helper function which translates ML smoother/solver paramters to MueLu XML string More...
 
static std::string & ltrim (std::string &s)
 
static std::string & rtrim (std::string &s)
 
static std::string & trim (std::string &s)
 

Detailed Description

Class that accepts ML-style parameters and builds a MueLu parameter list (easy input deck)

This interpreter class is meant to make the transition from ML to MueLu easier.

Definition at line 68 of file MueLu_ML2MueLuParameterTranslator.hpp.

Constructor & Destructor Documentation

◆ ML2MueLuParameterTranslator()

MueLu::ML2MueLuParameterTranslator::ML2MueLuParameterTranslator ( )
inline

Constructor.

Definition at line 74 of file MueLu_ML2MueLuParameterTranslator.hpp.

◆ ~ML2MueLuParameterTranslator()

virtual MueLu::ML2MueLuParameterTranslator::~ML2MueLuParameterTranslator ( )
inlinevirtual

Destructor.

Definition at line 77 of file MueLu_ML2MueLuParameterTranslator.hpp.

Member Function Documentation

◆ translate() [1/2]

static std::string MueLu::ML2MueLuParameterTranslator::translate ( Teuchos::ParameterList &  paramList,
const std::string &  defaultVals = "" 
)
inlinestatic

: Translate ML parameters to MueLu parameter XML string

Parameters
[in]paramList_inML parameter list
Returns
std::string with MueLu XML parameters

Definition at line 88 of file MueLu_ML2MueLuParameterTranslator.hpp.

◆ translate() [2/2]

static std::string MueLu::ML2MueLuParameterTranslator::translate ( const std::string &  xmlFileName,
const std::string &  defaultVals = "" 
)
inlinestatic

: Translate ML parameters to MueLu parameter XML string

Parameters
[in]xmlFileNamefile name with ML xml parameters
Returns
std::string with MueLu XML parameters

Definition at line 96 of file MueLu_ML2MueLuParameterTranslator.hpp.

◆ SetParameterList()

std::string MueLu::ML2MueLuParameterTranslator::SetParameterList ( const Teuchos::ParameterList &  paramList_in,
const std::string &  defaultVals 
)
staticprivate

: Interpret parameter list

Parameters
[in]paramList_inML parameter list
Returns
std::string with MueLu XML parameters

Definition at line 184 of file MueLu_ML2MueLuParameterTranslator.cpp.

◆ GetSmootherFactory()

std::string MueLu::ML2MueLuParameterTranslator::GetSmootherFactory ( const Teuchos::ParameterList &  paramList,
Teuchos::ParameterList &  adaptingParamList,
const std::string &  pname,
const std::string &  value 
)
staticprivate

: Helper function which translates ML smoother/solver paramters to MueLu XML string

Parameters
[in]paramListreference to Teuchos::ParameterList containing the ML smoother/solver parameters.
[in,out]adaptingParamListreference to Teuchos::ParameterList containing the ML smoother/solver parameters. Note that the processed parameters are removed from the ParameterList. It can be used to detect non-interpreted ML parameters.
[in]pnamecurrently processed parameter TODO
[in]valuecurrently processed value TODO

Definition at line 58 of file MueLu_ML2MueLuParameterTranslator.cpp.

◆ ltrim()

static std::string& MueLu::ML2MueLuParameterTranslator::ltrim ( std::string &  s)
inlinestaticprivate

Definition at line 130 of file MueLu_ML2MueLuParameterTranslator.hpp.

◆ rtrim()

static std::string& MueLu::ML2MueLuParameterTranslator::rtrim ( std::string &  s)
inlinestaticprivate

Definition at line 136 of file MueLu_ML2MueLuParameterTranslator.hpp.

◆ trim()

static std::string& MueLu::ML2MueLuParameterTranslator::trim ( std::string &  s)
inlinestaticprivate

Definition at line 142 of file MueLu_ML2MueLuParameterTranslator.hpp.

The documentation for this class was generated from the following files: