MueLu
Version of the Day
|
Factory for building Smoothed Aggregation prolongators.
#include <MueLu_SaPFactory_decl.hpp>
Constructors/Destructors. | |
SaPFactory () | |
Constructor. User can supply a factory for generating the tentative prolongator. More... | |
virtual | ~SaPFactory () |
Destructor. More... | |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
void | DeclareInput (Level &fineLevel, Level &coarseLevel) const |
Input. More... | |
Build methods. | |
void | Build (Level &fineLevel, Level &coarseLevel) const |
Build method. More... | |
void | BuildP (Level &fineLevel, Level &coarseLevel) const |
Abstract Build method. More... | |
Additional Inherited Members | |
![]() | |
PFactory () | |
Constructor. More... | |
virtual | ~PFactory () |
Destructor. More... | |
void | setRestrictionMode (bool bRestrictionMode=false) |
bool | isRestrictionModeSet () |
returns restrictionMode flag More... | |
![]() | |
TwoLevelFactoryBase () | |
Constructor. More... | |
virtual | ~TwoLevelFactoryBase () |
Destructor. More... | |
virtual void | CallDeclareInput (Level &requestedLevel) const |
virtual void | CallBuild (Level &requestedLevel) const |
![]() | |
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 | ~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 |
virtual std::string | description () const |
Return a simple one-line description of this object. More... | |
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 | ~FactoryAcceptor () |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl () |
virtual void | SetParameterList (const 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 () |
![]() | |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
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... | |
![]() | |
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 |
![]() | |
bool | restrictionMode_ |
Factory for building Smoothed Aggregation prolongators.
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
sa: damping factor | double | 1.33 | * | * | Damping factor for smoothed aggregation transfer operators | |
sa: calculate eigenvalue estimate | bool | false | * | * | Force calculation of eigenvalue estimate during prolongator smoothing | |
sa: eigenvalue estimate num iterations | int | 10 | * | * | Number of power iterations to estimate max eigenvalue | |
A | Factory | null | * | * | Generating factory of the matrix A used during the prolongator smoothing process | |
P | Factory | null | * | * | Tentative prolongator factory (should be a TentativePFactory object). Note that if "P" is not provided the FactoryManager tries the factory which is generating the variable "Ptent" as input for "P". In the standard case using the default settings this is the non-smoothed tentative prolongation operator. |
The * in the master.xml
column denotes that the parameter is defined in the master.xml
file.
The * in the validated
column means that the parameter is declared in the list of valid input parameters (see SaPFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see SaPFactory::DeclareInput).
After SaPFactory::Build the following data is available (if requested)
Parameter | generated by | description |
---|---|---|
P | SaPFactory | Smoothed prolongator |
Definition at line 96 of file MueLu_SaPFactory_decl.hpp.
|
inline |
Constructor. User can supply a factory for generating the tentative prolongator.
Definition at line 108 of file MueLu_SaPFactory_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 111 of file MueLu_SaPFactory_decl.hpp.
|
virtual |
Return a const parameter list of valid parameters that setParameterList() will accept.
Also define the default values of parameters according to the input parameter list.
Reimplemented from MueLu::Factory.
Definition at line 67 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 83 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Build method.
Builds smoothed aggregation prolongator and returns it in coarseLevel
. FIXME what does the return code mean (unclear in MueMat)?
Implements MueLu::TwoLevelFactoryBase.
Definition at line 94 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Abstract Build method.
Implements MueLu::PFactory.
Definition at line 99 of file MueLu_SaPFactory_def.hpp.