MueLu
Version of the Day
|
block Gauss-Seidel method for blocked matrices More...
#include <MueLu_BlockedGaussSeidelSmoother_decl.hpp>
Public Member Functions | |
RCP< SmootherPrototype > | Copy () const |
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::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... | |
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 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 |
Private Types | |
typedef Xpetra::MapExtractor < Scalar, LocalOrdinal, GlobalOrdinal, Node > | MapExtractorClass |
Private Attributes | |
std::string | type_ |
smoother type More... | |
std::vector< Teuchos::RCP < const FactoryManagerBase > > | FactManager_ |
vector of factory managers More... | |
std::vector< Teuchos::RCP < const SmootherBase > > | Inverse_ |
vector of smoother/solver factories More... | |
std::vector< bool > | bIsBlockedOperator_ |
vector storing whether sub-block is a blocked operator (needed for nested blocked smoothers using Thyra GIDs) More... | |
RCP< FactoryBase > | AFact_ |
A Factory. More... | |
RCP< Matrix > | A_ |
block operator More... | |
RCP< const MapExtractorClass > | rangeMapExtractor_ |
range map extractor (from A_ generated by AFact) More... | |
RCP< const MapExtractorClass > | domainMapExtractor_ |
domain map extractor (from A_ generated by AFact) More... | |
Constructors / destructors | |
BlockedGaussSeidelSmoother () | |
Constructor. More... | |
virtual | ~BlockedGaussSeidelSmoother () |
Destructor. More... | |
RCP< const ParameterList > | GetValidParameterList () const |
Input. More... | |
void | DeclareInput (Level ¤tLevel) const |
Input. More... | |
void | AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos) |
Add a factory manager. More... | |
Setup and Apply methods. | |
void | Setup (Level ¤tLevel) |
Setup routine In the Setup method the Inverse_ vector is filled with the corresponding SmootherBase objects. Without the Inverse_ vector being filled we cannot call BlockedGaussSeidelSmoother::Apply. More... | |
void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the direct solver. Solves the linear system AX=B using the constructed solver. More... | |
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 |
Get a rough estimate of cost per iteration. More... | |
block Gauss-Seidel method for blocked matrices
Implementation of a block Gauss-Seidel methods for blocked matrices
LocalOrdinal | sweeps = 1: number of BGS sweeps |
Scalar | omega = 1.0: damping parameter |
RCP<FactoryBase> | AFact = Teuchos::null: factory for blocked "A" operator |
Use the AddFactoryManager routine to declare the subsmoothers/subsolvers for the block Gauss-Seidel method for the block rows. The corresponding factory manager has to provide a variable "A" (pointing to the subblock of the blocked A operator) and a smoother object (variable: "PreSmoother").
Example
Definition at line 121 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
Definition at line 124 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
MueLu::BlockedGaussSeidelSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedGaussSeidelSmoother | ( | ) |
Constructor.
Definition at line 78 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Destructor.
Definition at line 85 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::ParameterListAcceptor.
Definition at line 88 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 120 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
void MueLu::BlockedGaussSeidelSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager | ( | RCP< const FactoryManagerBase > | FactManager, |
int | pos | ||
) |
Add a factory manager.
Add a factory manager at a specific position
Definition at line 99 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Setup routine In the Setup method the Inverse_ vector is filled with the corresponding SmootherBase objects. Without the Inverse_ vector being filled we cannot call BlockedGaussSeidelSmoother::Apply.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 141 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Apply the direct solver. Solves the linear system AX=B
using the constructed solver.
X | initial guess |
B | right-hand side |
InitialGuessIsZero | This option has no effect. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 180 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 343 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 348 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
void MueLu::BlockedGaussSeidelSmoother< 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 356 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 373 of file MueLu_BlockedGaussSeidelSmoother_def.hpp.
|
private |
smoother type
Definition at line 196 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
vector of factory managers
Definition at line 199 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
vector of smoother/solver factories
Definition at line 202 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
vector storing whether sub-block is a blocked operator (needed for nested blocked smoothers using Thyra GIDs)
Definition at line 205 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
A Factory.
Definition at line 208 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
block operator
Definition at line 211 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
range map extractor (from A_ generated by AFact)
Definition at line 213 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.
|
private |
domain map extractor (from A_ generated by AFact)
Definition at line 214 of file MueLu_BlockedGaussSeidelSmoother_decl.hpp.