|
MueLu
Version of the Day
|
|
MueLu
Version of the Day
|
Generic Smoother Factory for generating the smoothers of the MG hierarchy. More...
#include <MueLu_SmootherFactory_decl.hpp>
Public Types | |
| typedef Scalar | scalar_type |
| typedef LocalOrdinal | local_ordinal_type |
| typedef GlobalOrdinal | global_ordinal_type |
| typedef Node | node_type |
Private Member Functions | |
| void | CheckPrototypes () const |
Private Attributes | |
| RCP< SmootherPrototype > | preSmootherPrototype_ |
| RCP< SmootherPrototype > | postSmootherPrototype_ |
Constructors/Destructors. | |
| SmootherFactory (RCP< SmootherPrototype > preAndPostSmootherPrototype=Teuchos::null) | |
| Constructor. More... | |
| SmootherFactory (RCP< SmootherPrototype > preSmootherPrototype, RCP< SmootherPrototype > postSmootherPrototype) | |
| virtual | ~SmootherFactory () |
Set/Get methods. | |
| void | SetSmootherPrototypes (RCP< SmootherPrototype > preAndPostSmootherPrototype) |
| Set smoother prototypes. More... | |
| void | SetSmootherPrototypes (RCP< SmootherPrototype > preSmootherPrototype, RCP< SmootherPrototype > postSmootherPrototype) |
| Set smoother prototypes. More... | |
| void | GetSmootherPrototypes (RCP< SmootherPrototype > &preSmootherPrototype, RCP< SmootherPrototype > &postSmootherPrototype) const |
| Get smoother prototypes. More... | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Input. More... | |
| void | DeclareInput (Level ¤tLevel) const |
| Specifies the data that this class needs, and the factories that generate that data. More... | |
Build methods. | |
| void | Build (Level ¤tLevel) const |
| Creates pre and post smoothers. More... | |
| void | BuildSmoother (Level ¤tLevel, const PreOrPost preOrPost=BOTH) const |
Overridden from Teuchos::Describable | |
| std::string | description () const |
| Return a simple one-line description of this object. More... | |
| void | describe (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const |
Additional Inherited Members | |
 Public Member Functions inherited from MueLu::SmootherFactoryBase | |
| SmootherFactoryBase () | |
| virtual | ~SmootherFactoryBase () |
| Public Member Functions inherited from MueLu::SingleLevelFactoryBase | |
| SingleLevelFactoryBase () | |
| Constructor. More... | |
| virtual | ~SingleLevelFactoryBase () |
| Destructor. More... | |
| virtual void | CallBuild (Level &requestedLevel) const |
| virtual void | CallDeclareInput (Level &requestedLevel) const |
| 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::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::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... | |
| Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| 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) |
| Public Member Functions inherited from Teuchos::VerboseObjectBase | |
| 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 |
| 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... | |
| 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::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 void | SetParameterList (const Teuchos::ParameterList ¶mList) |
| Set parameters from a parameter list and return with default values. More... | |
| 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 |
| Public Member Functions inherited from MueLu::ParameterListAcceptor | |
| ParameterListAcceptor () | |
| virtual | ~ParameterListAcceptor ()=default |
| Static Public Member Functions inherited from MueLu::Factory | |
| static void | EnableMultipleCheckGlobally () |
| static void | DisableMultipleCheckGlobally () |
| 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< FancyOStream > | getDefaultOStream () |
| 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 |
Generic Smoother Factory for generating the smoothers of the MG hierarchy.
This factory is generic and can produce any kind of Smoother.
The design of the Smoother factory is based on the prototype design pattern. The smoother factory uses prototypical instances of smoothers, and prototypes are cloned to produce the smoothers of the MG hierarchy.
See also:
There is one prototype for the pre-smoother and one for the post-smoother. Thus, this factory can produce two different smoothers for pre and post-smoothing. Prototypes are stored in this factory.
The type of smoother to create is determined by the prototypical instances. Prototypes store their own parameters (nits, omega), and the factory doesn't have any knowledge about that.
Definition at line 90 of file MueLu_SmootherFactory_decl.hpp.
| typedef Scalar MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type |
Definition at line 92 of file MueLu_SmootherFactory_decl.hpp.
| typedef LocalOrdinal MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 93 of file MueLu_SmootherFactory_decl.hpp.
| typedef GlobalOrdinal MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 94 of file MueLu_SmootherFactory_decl.hpp.
| typedef Node MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type |
Definition at line 95 of file MueLu_SmootherFactory_decl.hpp.
| MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SmootherFactory | ( | RCP< SmootherPrototype > | preAndPostSmootherPrototype = Teuchos::null | ) |
Constructor.
TODO update the documentation from Matlab syntax
The constructor takes as arguments pre-configured smoother object(s). They are used as prototypes by the factory.
SYNTAX
SmootherFactory(preSmootherPrototype_, postSmootherPrototype_);
preSmootherPrototype_ - prototype for pre-smoothers (SmootherPrototype) postSmootherPrototype_ - prototype for post-smoothers (SmootherPrototype,optional,default=preSmootherPrototype_)
EXAMPLES:
SmootherFactory = SmootherFactory(ChebySmoother(5,1/30))
or
nIts = 5; lambdaRatio = 1/30; Smoother = ChebySmoother() Smoother = Smoother.SetIts(nIts); Smoother = Smoother.SetLambdaRatio(1/30); SmootherFactory = SmootherFactory(Smoother);
To use different smoothers for pre and post smoothing, two prototypes can be passed in as argument: PreSmoother = ChebySmoother(2, 1/30) PostSmoother = ChebySmoother(10,1/30) SmootherFactory = SmootherFactory(PreSmoother, PostSmoother);
[] is also a valid smoother which do nothing: PostSmoother = ChebySmoother(10,1/30) SmootherFactory = SmootherFactory([], PostSmoother);
Definition at line 58 of file MueLu_SmootherFactory_def.hpp.
| MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SmootherFactory | ( | RCP< SmootherPrototype > | preSmootherPrototype, |
| RCP< SmootherPrototype > | postSmootherPrototype | ||
| ) |
Definition at line 63 of file MueLu_SmootherFactory_def.hpp.
|
inlinevirtual |
Definition at line 149 of file MueLu_SmootherFactory_decl.hpp.
| void MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetSmootherPrototypes | ( | RCP< SmootherPrototype > | preAndPostSmootherPrototype | ) |
Set smoother prototypes.
Definition at line 69 of file MueLu_SmootherFactory_def.hpp.
| void MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetSmootherPrototypes | ( | RCP< SmootherPrototype > | preSmootherPrototype, |
| RCP< SmootherPrototype > | postSmootherPrototype | ||
| ) |
Set smoother prototypes.
Definition at line 75 of file MueLu_SmootherFactory_def.hpp.
| void MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetSmootherPrototypes | ( | RCP< SmootherPrototype > & | preSmootherPrototype, |
| RCP< SmootherPrototype > & | postSmootherPrototype | ||
| ) | const |
Get smoother prototypes.
Definition at line 103 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::ParameterListAcceptor.
Definition at line 83 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Specifies the data that this class needs, and the factories that generate that data.
If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 110 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Creates pre and post smoothers.
Factory.Build() clones its prototypes and calls Setup() on the new objects to create fully functional smoothers for the current hierarchy level. Note that smoothers do their own setup (ie: ILUSmoother.Setup() computes the ILU factorization).
If pre and post smoother are identical, the Setup() phase is done only once: to create the post-smoother, the pre-smoother is duplicated and its parameters are changed according to the parameters of the post-smoother prototype.
If the parameters of pre and post smoothers are not the same, the Setup() phase is also done only once when parameters don't change the result of the setup computation.
Implements MueLu::SmootherFactoryBase.
Definition at line 119 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Implements MueLu::SmootherFactoryBase.
Definition at line 124 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 244 of file MueLu_SmootherFactory_def.hpp.
|
virtual |
Reimplemented from MueLu::Describable.
Definition at line 254 of file MueLu_SmootherFactory_def.hpp.
|
private |
Definition at line 95 of file MueLu_SmootherFactory_def.hpp.
|
private |
Definition at line 211 of file MueLu_SmootherFactory_decl.hpp.
|
private |
Definition at line 212 of file MueLu_SmootherFactory_decl.hpp.
1.8.5 
