MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Class that encapsulates Matlab smoothers. More...

#include <MueLu_MatlabSmoother_fwd.hpp>

Inheritance diagram for MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Factory MueLu::BaseClass MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::VerboseObject MueLu::Describable MueLu::BaseClass MueLu::ParameterListAcceptor Teuchos::VerboseObject< VerboseObject > Teuchos::Describable MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

void SetParameterList (const Teuchos::ParameterList &paramList)
 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...
 
- Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 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
 
- Public Member Functions inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 SmootherBase ()
 
virtual ~SmootherBase ()
 
void declareConstructionOutcome (bool fail, std::string msg)
 
bool constructionSuccessful ()
 
std::string constructionErrorMsg ()
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- Public Member Functions inherited from MueLu::Describable
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...
 
- Public Member Functions inherited from Teuchos::Describable
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)
 
- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor. More...
 
virtual ~FactoryBase ()
 Destructor. More...
 
int GetID () const
 return unique factory id More...
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase
GetFactory (const std::string &varName) const =0
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 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 ParameterEntryGetParameter (const std::string &name) const
 Retrieves a const entry with the name name. More...
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
GetValidParameterList () const =0
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

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 &paramList=Teuchos::ParameterList())
 
virtual ~MatlabSmoother ()
 Destructor. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 

Computational methods.

void Setup (Level &currentLevel)
 Set up the smoother. More...
 
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply the preconditioner. More...
 

Utilities

RCP< SmootherPrototypeCopy () 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

- Public Types inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Types inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Static Public Member Functions inherited from MueLu::VerboseObject
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 Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

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 51 of file MueLu_MatlabSmoother_fwd.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatlabSmoother ( const Teuchos::ParameterList paramList = Teuchos::ParameterList())

Definition at line 58 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
virtual MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MatlabSmoother ( )
inlinevirtual

Destructor.

Definition at line 99 of file MueLu_MatlabSmoother_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetParameterList ( const Teuchos::ParameterList paramList)
virtual

Set parameters from a parameter list and return with default values.

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 64 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level currentLevel)
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 89 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( MultiVector &  X,
const MultiVector &  B,
bool  InitialGuessIsZero = false 
) const
virtual

Apply the preconditioner.

Solves the linear system AX=B using the constructed smoother.

Parameters
Xinitial guess
Bright-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 109 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const
virtual
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
template<typename Node2 >
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 189 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 142 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
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 153 of file MueLu_MatlabSmoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
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 159 of file MueLu_MatlabSmoother_decl.hpp.

Friends And Related Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
friend class MatlabSmoother
friend

Constructor.

ADD DOCUMENTATION HERE

Definition at line 93 of file MueLu_MatlabSmoother_decl.hpp.

Member Data Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::needsSetup_
mutableprivate

List of arguments to the MATLAB setup function besides "A", in order.

Definition at line 167 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::solveDataSize_
private

Amount of solve data (besides A, LHS & RHS)

Definition at line 170 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector<Teuchos::RCP<MuemexArg> > MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::solveData_
private

List of data generated by setup which will be sent to solve after "A", "LHS" and "RHS".

Definition at line 173 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setupFunction_
private

Matlab setup function.

Definition at line 176 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::solveFunction_
private

Matlab solve function.

Definition at line 179 of file MueLu_MatlabSmoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<Matrix> MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_
mutableprivate

Matrix, (maybe) used in apply.

Definition at line 182 of file MueLu_MatlabSmoother_decl.hpp.


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