MueLu
Version of the Day
|
SIMPLE smoother for 2x2 block matrices. More...
#include <MueLu_SimpleSmoother_decl.hpp>
Public Member Functions | |
RCP< SmootherPrototype > | Copy () const |
![]() | |
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 |
![]() | |
SmootherBase () | |
virtual | ~SmootherBase () |
void | declareConstructionOutcome (bool fail, std::string msg) |
bool | constructionSuccessful () |
std::string | constructionErrorMsg () |
![]() | |
virtual | ~BaseClass () |
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 |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. More... | |
![]() | |
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... | |
![]() | |
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 FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() More... | |
RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
![]() | |
FactoryBase () | |
Constructor. More... | |
virtual | ~FactoryBase () |
Destructor. More... | |
int | GetID () const |
return unique factory id More... | |
![]() | |
virtual | ~FactoryAcceptor () |
![]() | |
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 |
![]() | |
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_ |
RCP< Matrix > | A_ |
Internal blocked operator "A" generated by AFact_. 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< 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... | |
Constructors / destructors | |
SimpleSmoother () | |
Constructor. More... | |
virtual | ~SimpleSmoother () |
Destructor. More... | |
RCP< const ParameterList > | GetValidParameterList () const |
Input. More... | |
void | DeclareInput (Level ¤tLevel) 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 ¤tLevel) |
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... | |
Teuchos::RCP< Vector > | diagFinv_ |
Inverse diagonal of fluid operator (vector). 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... | |
Additional Inherited Members | |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. More... | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. More... | |
![]() | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
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 > | |
T | Get (Level &level, const std::string &varName) const |
template<class T > | |
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 bool | timerSync_ = false |
SIMPLE smoother for 2x2 block matrices.
Definition at line 87 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Definition at line 89 of file MueLu_SimpleSmoother_decl.hpp.
MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SimpleSmoother | ( | ) |
Constructor.
Definition at line 79 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Destructor.
Definition at line 83 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Input.
Reimplemented from MueLu::Factory.
Definition at line 86 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 132 of file MueLu_SimpleSmoother_def.hpp.
void MueLu::SimpleSmoother< 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 122 of file MueLu_SimpleSmoother_def.hpp.
void MueLu::SimpleSmoother< 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 127 of file MueLu_SimpleSmoother_def.hpp.
void MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager | ( | RCP< const FactoryManagerBase > | FactManager, |
int | pos | ||
) |
Add a factory manager at a specific position.
Definition at line 99 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Setup routine.
The Setup() routine can be summarized in 4 steps:
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 148 of file MueLu_SimpleSmoother_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 222 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 374 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 379 of file MueLu_SimpleSmoother_def.hpp.
void MueLu::SimpleSmoother< 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 387 of file MueLu_SimpleSmoother_def.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 400 of file MueLu_SimpleSmoother_def.hpp.
|
private |
smoother type
Generating factory for operator "A"
Definition at line 169 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Definition at line 172 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Internal blocked operator "A" generated by AFact_.
Definition at line 175 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Range map extractor (from A_ generated by AFact)
Definition at line 178 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Domain map extractor (from A_ generated by AFact)
Definition at line 181 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Inverse diagonal of fluid operator (vector).
Matrices
Definition at line 187 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Fluid operator.
Definition at line 190 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Pressure gradient operator.
Definition at line 193 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Divergence operator.
Definition at line 196 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Pressure stabilization term or null block.
Definition at line 199 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Smoother for velocity prediction.
Definition at line 204 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Smoother for SchurComplement equation.
Definition at line 207 of file MueLu_SimpleSmoother_decl.hpp.
|
private |
Vector of internal factory managers.
Definition at line 214 of file MueLu_SimpleSmoother_decl.hpp.