|
MueLu Version of the Day
|
Block triangle Uzawa smoother for 2x2 block matrices. More...
#include <MueLu_UzawaSmoother_decl.hpp>
Public Member Functions | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Input. More... | |
| void | DeclareInput (Level ¤tLevel) const |
| Input. More... | |
| void | SetVelocityPredictionFactoryManager (RCP< FactoryManager > FactManager) |
| Set factory manager for internal velocity prediction. More... | |
| void | SetSchurCompFactoryManager (RCP< FactoryManager > FactManager) |
| Set factory manager for internal SchurComplement handling. More... | |
| void | AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos) |
| Add a factory manager at a specific position. 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 | DeclareInput (Level ¤tLevel) const=0 |
| Input. More... | |
| 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< 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 > | |
| 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 |
| 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 |
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 |
Overridden from Teuchos::Describable | |
| std::string | type_ = "Uzawa" |
| smoother type More... | |
| RCP< const FactoryBase > | AFact_ |
| A Factory. More... | |
| RCP< Matrix > | A_ = Teuchos::null |
| 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... | |
| Teuchos::RCP< Vector > | diagFinv_ |
| matrices More... | |
| Teuchos::RCP< Matrix > | F_ |
| fluid operator More... | |
| Teuchos::RCP< Matrix > | G_ |
| pressure gradient operator More... | |
| Teuchos::RCP< Matrix > | D_ |
| divergence operator More... | |
| Teuchos::RCP< Matrix > | Z_ |
| pressure stabilization term or null block More... | |
| Teuchos::RCP< SmootherBase > | velPredictSmoo_ |
| smoother for velocity prediction More... | |
| Teuchos::RCP< SmootherBase > | schurCompSmoo_ |
| smoother for SchurComplement equation More... | |
| std::vector< Teuchos::RCP< const FactoryManagerBase > > | FactManager_ |
| Vector of internal factory managers. 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, MultiVector const &B, bool InitialGuessIsZero=false) const |
| Apply the Braess Sarazin smoother. More... | |
| RCP< SmootherPrototype > | Copy () const |
Block triangle Uzawa smoother for 2x2 block matrices.
Definition at line 87 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
Definition at line 89 of file MueLu_UzawaSmoother_decl.hpp.
|
virtual |
Input.
Reimplemented from MueLu::Factory.
Definition at line 73 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Input.
Definition at line 117 of file MueLu_UzawaSmoother_def.hpp.
| void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetVelocityPredictionFactoryManager | ( | RCP< FactoryManager > | FactManager | ) |
Set factory manager for internal velocity prediction.
Definition at line 107 of file MueLu_UzawaSmoother_def.hpp.
| void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetSchurCompFactoryManager | ( | RCP< FactoryManager > | FactManager | ) |
Set factory manager for internal SchurComplement handling.
Definition at line 112 of file MueLu_UzawaSmoother_def.hpp.
| void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager | ( | RCP< const FactoryManagerBase > | FactManager, |
| int | pos | ||
| ) |
Add a factory manager at a specific position.
See FactManager_ to explanation of positions.
Definition at line 84 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Setup routine.
Definition at line 133 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Apply the Braess Sarazin smoother.
| X | initial guess |
| B | right-hand side |
| InitialGuessIsZero | TODO This option has no effect. |
Definition at line 173 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Definition at line 283 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 288 of file MueLu_UzawaSmoother_def.hpp.
| void MueLu::UzawaSmoother< 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 296 of file MueLu_UzawaSmoother_def.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Definition at line 309 of file MueLu_UzawaSmoother_def.hpp.
|
private |
smoother type
Definition at line 158 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
A Factory.
Definition at line 160 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
block operator
Definition at line 163 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
range map extractor (from A_ generated by AFact)
Definition at line 165 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
domain map extractor (from A_ generated by AFact)
Definition at line 166 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
matrices
inverse diagonal of fluid operator (vector).
Definition at line 169 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
fluid operator
Definition at line 170 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
pressure gradient operator
Definition at line 171 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
divergence operator
Definition at line 172 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
pressure stabilization term or null block
Definition at line 173 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
smoother for velocity prediction
Definition at line 175 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
smoother for SchurComplement equation
Definition at line 176 of file MueLu_UzawaSmoother_decl.hpp.
|
private |
Vector of internal factory managers.
Definition at line 184 of file MueLu_UzawaSmoother_decl.hpp.