| 
    MueLu
    Version of the Day
    
   | 
 
BraessSarazin smoother for 2x2 block matrices. More...
#include <MueLu_BraessSarazinSmoother_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 () | 
  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... | |
| RCP< const FactoryBase > | AFact_ | 
| A Factory.  More... | |
| RCP< const FactoryManagerBase > | FactManager_ | 
| Factory manager for creating the Schur Complement.  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... | |
| 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... | |
Constructors / destructors | |
| BraessSarazinSmoother () | |
| Constructor.  More... | |
| virtual | ~BraessSarazinSmoother () | 
| Destructor.  More... | |
| 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... | |
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... | |
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... | |
BraessSarazin smoother for 2x2 block matrices.
Definition at line 90 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Definition at line 92 of file MueLu_BraessSarazinSmoother_decl.hpp.
| MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BraessSarazinSmoother | ( | ) | 
Constructor.
Definition at line 83 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Destructor.
Definition at line 115 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Input.
Implements MueLu::ParameterListAcceptor.
Definition at line 125 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 143 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.
Add a factory manager at a specific position.
Definition at line 119 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Setup routine.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 168 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 240 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 405 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  virtual | 
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 411 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.
Definition at line 419 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 432 of file MueLu_BraessSarazinSmoother_def.hpp.
      
  | 
  private | 
smoother type
Definition at line 157 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
A Factory.
Definition at line 159 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Factory manager for creating the Schur Complement.
Definition at line 160 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
block operator
Definition at line 163 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
range map extractor (from A_ generated by AFact)
Definition at line 165 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
domain map extractor (from A_ generated by AFact)
Definition at line 166 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
matrices
Block (0,0) [typically, fluid operator]
Definition at line 169 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Block (0,1) [typically, pressure gradient operator].
Definition at line 170 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Block (1,0) [typically, divergence operator].
Definition at line 171 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Block (1,1) [typically, pressure stabilization term or null block].
Definition at line 172 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Schur complement.
Definition at line 173 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 174 of file MueLu_BraessSarazinSmoother_decl.hpp.
      
  | 
  private | 
Smoother for SchurComplement equation.
Definition at line 176 of file MueLu_BraessSarazinSmoother_decl.hpp.