MueLu  Version of the Day
MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Block triangle Uzawa smoother for 2x2 block matrices. More...

#include <MueLu_UzawaSmoother_decl.hpp>

Inheritance diagram for MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Factory MueLu::BaseClass MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::VerboseObject MueLu::Describable MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Public Member Functions

RCP< SmootherPrototypeCopy () 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 &requestedLevel) 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 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 MueLu::Factory
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
 Factory ()
 Constructor. More...
 
virtual ~Factory ()
 Destructor. More...
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration. More...
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) 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 ()
 
virtual void SetParameterList (const ParameterList &paramList)
 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 ()
 

Private Types

typedef Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
 

Private Attributes

std::string type_
 smoother type More...
 
RCP< const FactoryBaseAFact_
 A Factory. More...
 
RCP< Matrix > A_
 block operator More...
 
RCP< const MapExtractorClassrangeMapExtractor_
 range map extractor (from A_ generated by AFact) More...
 
RCP< const MapExtractorClassdomainMapExtractor_
 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< SmootherBasevelPredictSmoo_
 smoother for velocity prediction More...
 
Teuchos::RCP< SmootherBaseschurCompSmoo_
 smoother for SchurComplement equation More...
 
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
 vector of factory managers More...
 

Constructors / destructors

 UzawaSmoother ()
 Constructor. More...
 
virtual ~UzawaSmoother ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const
 Input. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 
void SetVelocityPredictionFactoryManager (RCP< FactoryManager > FactManager)
 
void SetSchurCompFactoryManager (RCP< FactoryManager > FactManager)
 
void AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos)
 Add a factory manager at a specific position. More...
 

Setup and Apply methods.

void Setup (Level &currentLevel)
 Setup routine. More...
 
void Apply (MultiVector &X, MultiVector const &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...
 

Additional Inherited Members

- Public Types inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Types inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
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 MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Protected Member Functions inherited from MueLu::Factory
void Input (Level &level, const std::string &varName) const
 
void Input (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
Get (Level &level, const std::string &varName) const
 
template<class T >
Get (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
void Set (Level &level, const std::string &varName, const T &data) const
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Block triangle Uzawa smoother for 2x2 block matrices.

Definition at line 93 of file MueLu_UzawaSmoother_decl.hpp.

Member Typedef Documentation

◆ MapExtractorClass

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractorClass
private

Definition at line 95 of file MueLu_UzawaSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ UzawaSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::UzawaSmoother ( )

Constructor.

Definition at line 84 of file MueLu_UzawaSmoother_def.hpp.

◆ ~UzawaSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~UzawaSmoother ( )
virtual

Destructor.

Definition at line 90 of file MueLu_UzawaSmoother_def.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
virtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 93 of file MueLu_UzawaSmoother_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual

◆ SetVelocityPredictionFactoryManager()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetVelocityPredictionFactoryManager ( RCP< FactoryManager FactManager)

Set factory manager for internal velocity prediction This routine is outdated. Use AddFactoryManager instead

Definition at line 128 of file MueLu_UzawaSmoother_def.hpp.

◆ SetSchurCompFactoryManager()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetSchurCompFactoryManager ( RCP< FactoryManager FactManager)

Set factory manager for internal SchurComplement handling This routine is outdated. Use AddFactoryManager instead

Definition at line 133 of file MueLu_UzawaSmoother_def.hpp.

◆ AddFactoryManager()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager ( RCP< const FactoryManagerBase FactManager,
int  pos 
)

Add a factory manager at a specific position.

Definition at line 105 of file MueLu_UzawaSmoother_def.hpp.

◆ Setup()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level currentLevel)
virtual

◆ Apply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( MultiVector &  X,
MultiVector const &  B,
bool  InitialGuessIsZero = false 
) const
virtual

Apply the Braess Sarazin smoother.

Parameters
Xinitial guess
Bright-hand side
InitialGuessIsZeroTODO This option has no effect.

Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 194 of file MueLu_UzawaSmoother_def.hpp.

◆ Copy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const
virtual

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 309 of file MueLu_UzawaSmoother_def.hpp.

◆ print()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
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 317 of file MueLu_UzawaSmoother_def.hpp.

◆ getNodeSmootherComplexity()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
virtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 330 of file MueLu_UzawaSmoother_def.hpp.

Member Data Documentation

◆ type_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
std::string MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_
private

smoother type

Definition at line 168 of file MueLu_UzawaSmoother_decl.hpp.

◆ AFact_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const FactoryBase> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AFact_
private

A Factory.

Definition at line 170 of file MueLu_UzawaSmoother_decl.hpp.

◆ A_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Matrix> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_
private

block operator

Definition at line 173 of file MueLu_UzawaSmoother_decl.hpp.

◆ rangeMapExtractor_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const MapExtractorClass> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rangeMapExtractor_
private

range map extractor (from A_ generated by AFact)

Definition at line 175 of file MueLu_UzawaSmoother_decl.hpp.

◆ domainMapExtractor_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const MapExtractorClass> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainMapExtractor_
private

domain map extractor (from A_ generated by AFact)

Definition at line 176 of file MueLu_UzawaSmoother_decl.hpp.

◆ diagFinv_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<Vector> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::diagFinv_
private

matrices

inverse diagonal of fluid operator (vector).

Definition at line 179 of file MueLu_UzawaSmoother_decl.hpp.

◆ F_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<Matrix> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::F_
private

fluid operator

Definition at line 180 of file MueLu_UzawaSmoother_decl.hpp.

◆ G_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<Matrix> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::G_
private

pressure gradient operator

Definition at line 181 of file MueLu_UzawaSmoother_decl.hpp.

◆ D_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<Matrix> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::D_
private

divergence operator

Definition at line 182 of file MueLu_UzawaSmoother_decl.hpp.

◆ Z_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<Matrix> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Z_
private

pressure stabilization term or null block

Definition at line 183 of file MueLu_UzawaSmoother_decl.hpp.

◆ velPredictSmoo_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<SmootherBase> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::velPredictSmoo_
private

smoother for velocity prediction

Definition at line 185 of file MueLu_UzawaSmoother_decl.hpp.

◆ schurCompSmoo_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<SmootherBase> MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::schurCompSmoo_
private

smoother for SchurComplement equation

Definition at line 186 of file MueLu_UzawaSmoother_decl.hpp.

◆ FactManager_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
std::vector<Teuchos::RCP<const FactoryManagerBase> > MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_
private

vector of factory managers

vector of internal factory managers FactManager_[0] holds the factory manager for the predicting the primary variable FactManager_[1] stores the factory manager used for the SchurComplement correction step.

Definition at line 194 of file MueLu_UzawaSmoother_decl.hpp.


The documentation for this class was generated from the following files: