MueLu
Version of the Day
|
Base class for factories that use one level (currentLevel). More...
#include <MueLu_SingleLevelFactoryBase.hpp>
Constructors/Destructors. | |
SingleLevelFactoryBase () | |
Constructor. More... | |
virtual | ~SingleLevelFactoryBase () |
Destructor. More... | |
Input | |
virtual void | DeclareInput (Level ¤tLevel) const =0 |
Specifies the data that this class needs, and the factories that generate that data. More... | |
Build methods. | |
virtual void | Build (Level ¤tLevel) const =0 |
Build an object with this factory. More... | |
virtual void | CallBuild (Level &requestedLevel) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
Additional Inherited Members | |
![]() | |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. 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 | ~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 |
Base class for factories that use one level (currentLevel).
Definition at line 64 of file MueLu_SingleLevelFactoryBase.hpp.
|
inline |
Constructor.
Definition at line 71 of file MueLu_SingleLevelFactoryBase.hpp.
|
inlinevirtual |
Destructor.
Definition at line 74 of file MueLu_SingleLevelFactoryBase.hpp.
|
pure virtual |
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.
Implemented in MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >, MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionHeuristicFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NullspaceFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::CloneRepartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SubBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IsorropiaInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::ReorderBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::UserAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::SegregatedAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SingleLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RebalanceMapFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::DropNegativeEntriesFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedBlockedMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::FilteredAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::DemoFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NullspacePresmoothFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::TopSmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
|
pure virtual |
Build an object with this factory.
Implemented in MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >, MueLu::SmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionHeuristicFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NullspaceFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SubBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::CloneRepartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ReorderBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SegregatedAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IsorropiaInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::UserAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::DropNegativeEntriesFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SingleLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::FilteredAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RebalanceMapFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedBlockedMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::DemoFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NullspacePresmoothFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SmootherFactoryBase, and MueLu::TopSmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
|
inlinevirtual |
Implements MueLu::FactoryBase.
Definition at line 97 of file MueLu_SingleLevelFactoryBase.hpp.
|
inlinevirtual |
Implements MueLu::FactoryBase.
Definition at line 152 of file MueLu_SingleLevelFactoryBase.hpp.