|
MueLu
Version of the Day
|
BraessSarazin smoother for 2x2 block matrices. More...
#include <MueLu_BraessSarazinSmoother_decl.hpp>
Public Member Functions | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Input. More... | |
| void | DeclareInput (Level ¤tLevel) const |
| Input. More... | |
| void | AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos=0) |
| Add a factory manager for BraessSarazin internal SchurComplement handling. More... | |
Public Member Functions inherited from MueLu::SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > | |
| SmootherPrototype () | |
| @nameConstructors/Destructors. More... | |
| virtual | ~SmootherPrototype () |
| virtual void | CallBuild (Level &) const |
| virtual void | CallDeclareInput (Level &requestedLevel) const |
| bool | IsSetup () const |
| Get the state of a smoother prototype. More... | |
| void | IsSetup (bool const &ToF) |
| Set the state of a smoother prototype. More... | |
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 | |
| VerboseObject () | |
| virtual | ~VerboseObject () |
| 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 |
Public Member Functions inherited from MueLu::Describable | |
| virtual | ~Describable () |
| Destructor. 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... | |
| virtual std::string | ShortClassName () const |
| Return the class name of the object, without template parameters and without namespace. More... | |
Public Member Functions inherited from MueLu::Factory | |
| 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 |
| void | EnableMultipleCallCheck () const |
| 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 () |
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 |
Overridden from Teuchos::Describable | |
| std::string | type_ = "Braess Sarazin" |
| smoother type More... | |
| RCP< const FactoryBase > | AFact_ |
| A Factory. More... | |
| RCP< const FactoryManagerBase > | FactManager_ |
| Factory manager for creating the Schur Complement. More... | |
| RCP< Matrix > | A_ = Teuchos::null |
| block operator More... | |
| RCP< const MapExtractor > | rangeMapExtractor_ |
| range map extractor (from A_ generated by AFact) More... | |
| RCP< const MapExtractor > | domainMapExtractor_ |
| domain map extractor (from A_ generated by AFact) More... | |
| RCP< Matrix > | A00_ |
| matrices More... | |
| RCP< Matrix > | A01_ |
| Block (0,1) [typically, pressure gradient operator]. More... | |
| RCP< Matrix > | A10_ |
| Block (1,0) [typically, divergence operator]. More... | |
| RCP< Matrix > | A11_ |
| Block (1,1) [typically, pressure stabilization term or null block]. More... | |
| RCP< Matrix > | S_ |
| Schur complement. More... | |
| RCP< Vector > | D_ |
| Inverse to approximation to block (0,0). Here, D_ = omega*inv(diag(A(0,0))) More... | |
| Teuchos::RCP< SmootherBase > | smoo_ |
| Smoother for SchurComplement equation. More... | |
| 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... | |
Setup and Apply methods. | |
| void | Setup (Level ¤tLevel) |
| Setup routine. More... | |
| void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
| Apply the Braess Sarazin smoother. More... | |
| RCP< SmootherPrototype > | Copy () const |
BraessSarazin smoother for 2x2 block matrices.
Definition at line 84 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
virtual |
Input.
Reimplemented from MueLu::Factory.
Definition at line 79 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Input.
Definition at line 96 of file MueLu_BraessSarazinSmoother_def.hpp.
| void MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager | ( | RCP< const FactoryManagerBase > | FactManager, |
| int | pos = 0 |
||
| ) |
Add a factory manager for BraessSarazin internal SchurComplement handling.
Definition at line 73 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Setup routine.
Setup routine can be summarized in 4 steps:
Definition at line 116 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Apply the Braess Sarazin smoother.
| X | initial guess |
| B | right-hand side |
| InitialGuessIsZero | TODO This option has no effect. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 171 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Definition at line 316 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 321 of file MueLu_BraessSarazinSmoother_def.hpp.
| void MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print | ( | Teuchos::FancyOStream & | out, |
| const VerbLevel | verbLevel = Default |
||
| ) | const |
Print the object with some verbosity level to an FancyOStream object.
Using MueLu::Describable::describe; overloading, not hiding
Definition at line 330 of file MueLu_BraessSarazinSmoother_def.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 343 of file MueLu_BraessSarazinSmoother_def.hpp.
|
private |
smoother type
Definition at line 147 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
A Factory.
Definition at line 149 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Factory manager for creating the Schur Complement.
Definition at line 150 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
block operator
Definition at line 153 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
range map extractor (from A_ generated by AFact)
Definition at line 155 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
domain map extractor (from A_ generated by AFact)
Definition at line 156 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
matrices
Block (0,0) [typically, fluid operator]
Definition at line 159 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Block (0,1) [typically, pressure gradient operator].
Definition at line 160 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Block (1,0) [typically, divergence operator].
Definition at line 161 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Block (1,1) [typically, pressure stabilization term or null block].
Definition at line 162 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Schur complement.
Definition at line 163 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Inverse to approximation to block (0,0). Here, D_ = omega*inv(diag(A(0,0)))
Definition at line 164 of file MueLu_BraessSarazinSmoother_decl.hpp.
|
private |
Smoother for SchurComplement equation.
Definition at line 166 of file MueLu_BraessSarazinSmoother_decl.hpp.