MueLu
Version of the Day
|
Class that encapsulates Matlab smoothers. More...
#include <MueLu_MatlabSmoother_fwd.hpp>
Public Member Functions | |
void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. More... | |
template<typename Node2 > | |
RCP< MueLu::MatlabSmoother < Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > | clone (const RCP< Node2 > &node2, const Teuchos::RCP< const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > &A_newnode) const |
Clone the smoother to a different node type. More... | |
![]() | |
SmootherPrototype () | |
/Destructors. More... | |
virtual | ~SmootherPrototype () |
bool | IsSetup () const |
Get the state of a smoother prototype. More... | |
void | IsSetup (bool const &ToF) |
Set the state of a smoother prototype. More... | |
virtual void | CallBuild (Level &) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
![]() | |
SmootherBase () | |
virtual | ~SmootherBase () |
void | declareConstructionOutcome (bool fail, std::string msg) |
bool | constructionSuccessful () |
std::string | constructionErrorMsg () |
![]() | |
virtual | ~BaseClass () |
Destructor. More... | |
![]() | |
VerbLevel | GetVerbLevel () const |
Get the verbosity level. More... | |
void | SetVerbLevel (const VerbLevel verbLevel) |
Set the verbosity level of this object. More... | |
int | GetProcRankVerbose () const |
Get proc rank used for printing. Do not use this information for any other purpose. More... | |
int | SetProcRankVerbose (int procRank) const |
Set proc rank used for printing. More... | |
bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
Find out whether we need to print out information for a specific message type. More... | |
Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. More... | |
Teuchos::FancyOStream & | GetBlackHole () const |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. More... | |
![]() | |
VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
virtual EVerbosityLevel | getVerbLevel () const |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
![]() | |
virtual | ~VerboseObjectBase () |
VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () const |
virtual std::string | getLinePrefix () const |
virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
![]() | |
virtual | ~Describable () |
Destructor. More... | |
virtual std::string | ShortClassName () const |
Return the class name of the object, without template parameters and without namespace. More... | |
virtual void | describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
Print the object with some verbosity level to an FancyOStream object. More... | |
![]() | |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
![]() | |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
void | EnableMultipleCallCheck () const |
void | DisableMultipleCallCheck () const |
void | ResetDebugData () const |
Factory () | |
Constructor. More... | |
virtual | ~Factory () |
Destructor. More... | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. More... | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() More... | |
RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
![]() | |
FactoryBase () | |
Constructor. More... | |
virtual | ~FactoryBase () |
Destructor. More... | |
int | GetID () const |
return unique factory id More... | |
![]() | |
virtual | ~FactoryAcceptor () |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual const Teuchos::ParameterList & | GetParameterList () const |
void | SetParameter (const std::string &name, const ParameterEntry &entry) |
Set a parameter directly as a ParameterEntry. More... | |
const ParameterEntry & | GetParameter (const std::string &name) const |
Retrieves a const entry with the name name. More... | |
virtual void | GetDocumentation (std::ostream &os) const |
![]() | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
Private Attributes | |
std::string | needsSetup_ |
List of arguments to the MATLAB setup function besides "A", in order. More... | |
size_t | solveDataSize_ |
Amount of solve data (besides A, LHS & RHS) More... | |
std::vector< Teuchos::RCP < MuemexArg > > | solveData_ |
List of data generated by setup which will be sent to solve after "A", "LHS" and "RHS". More... | |
std::string | setupFunction_ |
Matlab setup function. More... | |
std::string | solveFunction_ |
Matlab solve function. More... | |
RCP< Matrix > | A_ |
Matrix, (maybe) used in apply. More... | |
Constructors / destructors | |
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 > | |
class | MatlabSmoother |
Constructor. More... | |
MatlabSmoother (const Teuchos::ParameterList ¶mList=Teuchos::ParameterList()) | |
virtual | ~MatlabSmoother () |
Destructor. More... | |
void | DeclareInput (Level ¤tLevel) const |
Input. More... | |
Computational methods. | |
void | Setup (Level ¤tLevel) |
Set up the smoother. More... | |
void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the preconditioner. More... | |
Utilities | |
RCP< SmootherPrototype > | Copy () const |
Overridden from Teuchos::Describable | |
std::string | description () const |
Return a simple one-line description of this object. More... | |
void | print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const |
Print the object with some verbosity level to an FancyOStream object. More... | |
size_t | getNodeSmootherComplexity () const |
Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::OrdinalTraits<size_t>::invalid() if such an estimate cannot be computed. More... | |
Additional Inherited Members | |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP < Teuchos::FancyOStream > | GetMueLuOStream () |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. More... | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. More... | |
![]() | |
static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
static EVerbosityLevel | getDefaultVerbLevel () |
![]() | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
static RCP< FancyOStream > | getDefaultOStream () |
![]() | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
static const EVerbosityLevel | verbLevel_default |
![]() | |
void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
![]() | |
void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
virtual void | informUpdatedVerbosityState () const |
![]() | |
void | Input (Level &level, const std::string &varName) const |
void | Input (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
void | Set (Level &level, const std::string &varName, const T &data) const |
template<class T > | |
bool | IsType (Level &level, const std::string &varName) const |
bool | IsAvailable (Level &level, const std::string &varName) const |
![]() | |
static bool | timerSync_ = false |
Class that encapsulates Matlab smoothers.
This class creates an Matlab preconditioner factory. The factory creates a smoother based on the type and ParameterList passed into the constructor. See the constructor for more information.
Definition at line 18 of file MueLu_MatlabSmoother_fwd.hpp.
MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatlabSmoother | ( | const Teuchos::ParameterList & | paramList = Teuchos::ParameterList() | ) |
Definition at line 20 of file MueLu_MatlabSmoother_def.hpp.
|
inlinevirtual |
Destructor.
Definition at line 61 of file MueLu_MatlabSmoother_decl.hpp.
|
virtual |
Set parameters from a parameter list and return with default values.
Reimplemented from MueLu::ParameterListAcceptorImpl.
Definition at line 25 of file MueLu_MatlabSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 34 of file MueLu_MatlabSmoother_def.hpp.
|
virtual |
Set up the smoother.
This creates the underlying Matlab smoother object, copies any parameter list options supplied to the constructor to the Matlab object, and computes the preconditioner.
TODO The eigenvalue estimate should come from A_, not the Matlab parameter list.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 47 of file MueLu_MatlabSmoother_def.hpp.
|
virtual |
Apply the preconditioner.
Solves the linear system AX=B
using the constructed smoother.
X | initial guess |
B | right-hand side |
InitialGuessIsZero | (optional) If false, some work can be avoided. Whether this actually saves any work depends on the underlying Matlab implementation. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 66 of file MueLu_MatlabSmoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 93 of file MueLu_MatlabSmoother_def.hpp.
RCP< MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::clone | ( | const RCP< Node2 > & | node2, |
const Teuchos::RCP< const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > & | A_newnode | ||
) | const |
Clone the smoother to a different node type.
Definition at line 149 of file MueLu_MatlabSmoother_decl.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 100 of file MueLu_MatlabSmoother_def.hpp.
void MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print | ( | Teuchos::FancyOStream & | out, |
const VerbLevel | verbLevel = Default |
||
) | const |
Print the object with some verbosity level to an FancyOStream object.
Definition at line 111 of file MueLu_MatlabSmoother_def.hpp.
|
inlinevirtual |
Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::OrdinalTraits<size_t>::invalid() if such an estimate cannot be computed.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 121 of file MueLu_MatlabSmoother_decl.hpp.
|
friend |
|
mutableprivate |
List of arguments to the MATLAB setup function besides "A", in order.
Definition at line 127 of file MueLu_MatlabSmoother_decl.hpp.
|
private |
Amount of solve data (besides A, LHS & RHS)
Definition at line 130 of file MueLu_MatlabSmoother_decl.hpp.
|
private |
List of data generated by setup which will be sent to solve after "A", "LHS" and "RHS".
Definition at line 133 of file MueLu_MatlabSmoother_decl.hpp.
|
private |
Matlab setup function.
Definition at line 136 of file MueLu_MatlabSmoother_decl.hpp.
|
private |
Matlab solve function.
Definition at line 139 of file MueLu_MatlabSmoother_decl.hpp.
|
mutableprivate |
Matrix, (maybe) used in apply.
Definition at line 142 of file MueLu_MatlabSmoother_decl.hpp.