MueLu Version of the Day
|
Factory for building coarse matrices. More...
#include <MueLu_RebalanceAcFactory_decl.hpp>
Build methods. | |
std::vector< RCP< const FactoryBase > > | rebalanceFacts_ |
list of user-defined rebalancing Factories | |
void | Build (Level &fineLevel, Level &coarseLevel) const |
Build an object with this factory. | |
void | AddRebalanceFactory (const RCP< const FactoryBase > &factory) |
Add rebalancing factory in the end of list of rebalancing factories in RebalanceAcFactory. | |
size_t | NumRebalanceFactories () const |
Returns number of transfer factories. | |
Constructors/Destructors. | |
RebalanceAcFactory () | |
virtual | ~RebalanceAcFactory () |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
Input | |
void | DeclareInput (Level &fineLevel, Level &coarseLevel) const |
Input. | |
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.
Factory to perform rebalancing of coarse matrices.
Factory that performes the actual rebalancing of coarse maps based on pre-computed rebalancing data (generated by other factories).
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
A | string | null | * | * | Generating factory of the un-rebalanced coarse matrix | |
Importer | string | null | * | * | Generating factory of the importer used in rebalancing | |
SubImporters | string | null | * | * | ?? |
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 GetValidParameters()
).
The * in the requested
column states that the data is requested as input with all dependencies (see DeclareInput()
).
After Build()
, the following data is available (if requested):
Parameter | generated by | description |
---|---|---|
A | RebalanceBlockAcFactory | Rebalanced coarse matrix |
Definition at line 74 of file MueLu_RebalanceAcFactory_decl.hpp.
|
inline |
Definition at line 82 of file MueLu_RebalanceAcFactory_decl.hpp.
|
inlinevirtual |
Definition at line 84 of file MueLu_RebalanceAcFactory_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 64 of file MueLu_RebalanceAcFactory_def.hpp.
|
virtual |
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 80 of file MueLu_RebalanceAcFactory_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 91 of file MueLu_RebalanceAcFactory_def.hpp.
void MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddRebalanceFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add rebalancing factory in the end of list of rebalancing factories in RebalanceAcFactory.
Rebalancing factories are derived from SingleLevelFactoryBase and rebalance the underlaying object (e.g. map, vector,...) to fit to the rebalanced maps.
Definition at line 167 of file MueLu_RebalanceAcFactory_def.hpp.
|
inline |
Returns number of transfer factories.
Definition at line 110 of file MueLu_RebalanceAcFactory_decl.hpp.
|
private |
list of user-defined rebalancing Factories
Definition at line 116 of file MueLu_RebalanceAcFactory_decl.hpp.