MueLu Version of the Day
|
This class enables the elimination of the nullspace component of the solution through the use of projection. More...
#include <MueLu_ProjectorSmoother_decl.hpp>
Overridden from Teuchos::Describable | |
RCP< MultiVector > | Borth_ |
RCP< SmootherPrototype > | coarseSolver_ |
std::string | description () const |
Return a simple one-line description of this object. | |
void | print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const |
Print the object with some verbosity level to an FancyOStream object. | |
size_t | getNodeSmootherComplexity () const |
Get a rough estimate of cost per iteration. | |
Constructors / destructors | |
ProjectorSmoother (RCP< SmootherPrototype > coarseSolver) | |
Constructor. | |
virtual | ~ProjectorSmoother () |
Destructor. | |
void | DeclareInput (Level ¤tLevel) const |
Input. | |
Setup and Apply methods. | |
void | Setup (Level ¤tLevel) |
Set up the direct solver. | |
void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the direct solver. Solves the linear system AX=B using the constructed solver. | |
RCP< SmootherPrototype > | Copy () const |
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 |
![]() | |
SmootherPrototype () | |
@nameConstructors/Destructors. | |
virtual | ~SmootherPrototype () |
virtual void | CallBuild (Level &) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
bool | IsSetup () const |
Get the state of a smoother prototype. | |
void | IsSetup (bool const &ToF) |
Set the state of a smoother prototype. | |
![]() | |
SmootherBase () | |
virtual | ~SmootherBase () |
void | declareConstructionOutcome (bool fail, std::string msg) |
bool | constructionSuccessful () |
std::string | constructionErrorMsg () |
![]() | |
virtual | ~BaseClass () |
Destructor. | |
![]() | |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. | |
VerbLevel | GetVerbLevel () const |
Get the verbosity level. | |
void | SetVerbLevel (const VerbLevel verbLevel) |
Set the verbosity level of this object. | |
int | GetProcRankVerbose () const |
Get proc rank used for printing. Do not use this information for any other purpose. | |
int | SetProcRankVerbose (int procRank) const |
Set proc rank used for printing. | |
bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
Find out whether we need to print out information for a specific message type. | |
Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. | |
Teuchos::FancyOStream & | GetBlackHole () const |
![]() | |
virtual | ~Describable () |
Destructor. | |
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. | |
virtual std::string | ShortClassName () const |
Return the class name of the object, without template parameters and without namespace. | |
![]() | |
Factory () | |
Constructor. | |
virtual | ~Factory () |
Destructor. | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() | |
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. | |
void | EnableMultipleCallCheck () const |
void | DisableMultipleCallCheck () const |
void | ResetDebugData () const |
![]() | |
FactoryBase () | |
Constructor. | |
virtual | ~FactoryBase () |
Destructor. | |
int | GetID () const |
return unique factory id | |
![]() | |
virtual | ~FactoryAcceptor () |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. | |
virtual const Teuchos::ParameterList & | GetParameterList () const |
void | SetParameter (const std::string &name, const ParameterEntry &entry) |
Set a parameter directly as a ParameterEntry. | |
const ParameterEntry & | GetParameter (const std::string &name) const |
Retrieves a const entry with the name name. | |
virtual void | GetDocumentation (std::ostream &os) const |
![]() | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
![]() | |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
![]() | |
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 |
This class enables the elimination of the nullspace component of the solution through the use of projection.
The solution of the coarsest level system may have a significant nullspace component. We can try to eliminate it through the use of nullspaces. Due to our construction algorithms, we always have some nullspace vectors on the coarsest level. However, we do not know if they are true nullspace vectors or are only approximations to them.
We will use the Rayleigh quotiont to separate the true nullspace vectors. If Rayleigh quotient is less than specified epsilon, we consider the vector to be a true nullspace vector.
After we separate true nullspace vectors, we project our solution to the space orthogonal to them. To do that in a computationally efficient manner, in the Setup stage we orthonormalize the selected nullspace components.
Definition at line 80 of file MueLu_ProjectorSmoother_decl.hpp.
MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ProjectorSmoother | ( | RCP< SmootherPrototype > | coarseSolver | ) |
Constructor.
Definition at line 62 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Destructor.
Definition at line 67 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 70 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Set up the direct solver.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 78 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Apply the direct solver. Solves the linear system AX=B
using the constructed solver.
X | initial guess |
B | right-hand side |
InitialGuessIsZero | This option has no effect. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 140 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 161 of file MueLu_ProjectorSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 166 of file MueLu_ProjectorSmoother_def.hpp.
void MueLu::ProjectorSmoother< 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 173 of file MueLu_ProjectorSmoother_def.hpp.
|
inlinevirtual |
Get a rough estimate of cost per iteration.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 132 of file MueLu_ProjectorSmoother_decl.hpp.
|
private |
Definition at line 138 of file MueLu_ProjectorSmoother_decl.hpp.
|
private |
Definition at line 139 of file MueLu_ProjectorSmoother_decl.hpp.