MueLu Version of the Day
|
Factory for building coarse matrices. More...
#include <MueLu_BlockedRAPFactory_decl.hpp>
internal plausibility check methods | |
checks main diagonal entries of (0,0) block. Does not affect entries in (1,1) block! | |
bool | checkAc_ |
bool | repairZeroDiagonals_ |
std::vector< RCP< const FactoryBase > > | transferFacts_ |
list of user-defined transfer Factories | |
static void | CheckMainDiagonal (RCP< BlockedCrsMatrix > &bAc, bool repairZeroDiagonals=false) |
Constructors/Destructors. | |
BlockedRAPFactory () | |
virtual | ~BlockedRAPFactory ()=default |
Input | |
RCP< const ParameterList > | GetValidParameterList () const override |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
void | DeclareInput (Level &fineLevel, Level &coarseLevel) const override |
Input. | |
Build methods. | |
void | Build (Level &fineLevel, Level &coarseLevel) const override |
Build an object with this factory. | |
Handling of user-defined transfer factories | |
void | SetRepairZeroDiagonal (bool const &repair) |
Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0.0 set A(i,i) = 1.0) | |
void | SetPlausibilityCheck (bool const &check) |
Indicate that a simple plausibility check shall be done for Ac after building RAP. | |
void | AddTransferFactory (const RCP< const FactoryBase > &factory) |
Add transfer factory in the end of list of transfer factories in RepartitionAcFactory. | |
size_t | NumTransferFactories () const |
Returns number of transfer factories. | |
Additional Inherited Members | |
![]() | |
TwoLevelFactoryBase () | |
Constructor. | |
virtual | ~TwoLevelFactoryBase () |
Destructor. | |
virtual void | CallDeclareInput (Level &requestedLevel) const |
virtual void | CallBuild (Level &requestedLevel) const |
![]() | |
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 | ~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 |
virtual std::string | description () const |
Return a simple one-line description of this object. | |
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. | |
![]() | |
virtual | ~FactoryAcceptor () |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
Configuration. | |
virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
![]() | |
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 | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
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 () |
![]() | |
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 |
Factory for building coarse matrices.
Definition at line 73 of file MueLu_BlockedRAPFactory_decl.hpp.
MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedRAPFactory |
Definition at line 65 of file MueLu_BlockedRAPFactory_def.hpp.
|
virtualdefault |
|
overridevirtual |
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 70 of file MueLu_BlockedRAPFactory_def.hpp.
|
overridevirtual |
Input.
Specifies the data that this class needs, and the factories that generate that data.
If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 84 of file MueLu_BlockedRAPFactory_def.hpp.
|
overridevirtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 98 of file MueLu_BlockedRAPFactory_def.hpp.
|
inline |
Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0.0 set A(i,i) = 1.0)
Definition at line 104 of file MueLu_BlockedRAPFactory_decl.hpp.
|
inline |
Indicate that a simple plausibility check shall be done for Ac after building RAP.
Definition at line 110 of file MueLu_BlockedRAPFactory_decl.hpp.
void MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddTransferFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.
Transfer factories are derived from TwoLevelFactoryBase and project some data from the fine level to the next coarser level.
Definition at line 220 of file MueLu_BlockedRAPFactory_def.hpp.
|
inline |
Returns number of transfer factories.
Definition at line 125 of file MueLu_BlockedRAPFactory_decl.hpp.
|
staticprivate |
Definition at line 179 of file MueLu_BlockedRAPFactory_def.hpp.
|
private |
If true, perform a basic plausibility check on Ac (default = false) note, that the repairZeroDiagonals_ flag only is valid for checkAc_ == true
Definition at line 137 of file MueLu_BlockedRAPFactory_decl.hpp.
|
private |
If true, the CheckMainDiagonal routine automatically repairs zero entries on main diagonal (default = false) i.e. if A(i,i) == 0.0 set A(i,i) = 1.0 note, that the repairZeroDiagonals_ flag only is valid for checkAc_ == true
Definition at line 142 of file MueLu_BlockedRAPFactory_decl.hpp.
|
private |
list of user-defined transfer Factories
Definition at line 147 of file MueLu_BlockedRAPFactory_decl.hpp.