MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::SingleLevelFactoryBase Class Referenceabstract

Base class for factories that use one level (currentLevel). More...

#include <MueLu_SingleLevelFactoryBase.hpp>

Inheritance diagram for MueLu::SingleLevelFactoryBase:
MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::CloneRepartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node > MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::DemoFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::DropNegativeEntriesFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::FilteredAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::FineLevelInputDataFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::HybridAggregationFactory< LocalOrdinal, GlobalOrdinal, Node > MueLu::IsorropiaInterface< LocalOrdinal, GlobalOrdinal, Node > MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::MergedBlockedMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::NodePartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::NullspaceFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::NullspacePresmoothFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::PermutationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::RebalanceMapFactory< LocalOrdinal, GlobalOrdinal, Node > MueLu::ReorderBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::RepartitionBlockDiagonalFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::RepartitionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::RepartitionHeuristicFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::RepartitionInterface< LocalOrdinal, GlobalOrdinal, Node > MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SegregatedAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SingleLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SmootherFactoryBase MueLu::StructuredAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::StructuredLineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SubBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::TopSmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node > MueLu::UserAggregationFactory< LocalOrdinal, GlobalOrdinal, Node > MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode > MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Constructors/Destructors.

 SingleLevelFactoryBase ()
 Constructor. More...
 
virtual ~SingleLevelFactoryBase ()
 Destructor. More...
 

Input

virtual void DeclareInput (Level &currentLevel) const =0
 Specifies the data that this class needs, and the factories that generate that data. More...
 

Build methods.

virtual void Build (Level &currentLevel) const =0
 Build an object with this factory. More...
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor. More...
 
virtual ~FactoryBase ()
 Destructor. More...
 
int GetID () const
 return unique factory id More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- Public Member Functions inherited from MueLu::Describable
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...
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase
GetFactory (const std::string &varName) const =0
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
virtual void SetParameterList (const Teuchos::ParameterList &paramList)
 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 ParameterEntryGetParameter (const std::string &name) const
 Retrieves a const entry with the name name. More...
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
GetValidParameterList () const =0
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static Teuchos::RCP
< Teuchos::FancyOStream
GetMueLuOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

Base class for factories that use one level (currentLevel).

Definition at line 64 of file MueLu_SingleLevelFactoryBase.hpp.

Constructor & Destructor Documentation

MueLu::SingleLevelFactoryBase::SingleLevelFactoryBase ( )
inline

Constructor.

Definition at line 71 of file MueLu_SingleLevelFactoryBase.hpp.

virtual MueLu::SingleLevelFactoryBase::~SingleLevelFactoryBase ( )
inlinevirtual

Destructor.

Definition at line 74 of file MueLu_SingleLevelFactoryBase.hpp.

Member Function Documentation

virtual void MueLu::SingleLevelFactoryBase::DeclareInput ( Level currentLevel) const
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::HybridAggregationFactory< 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::StructuredAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NodePartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::VariableDofLaplacianFactory< 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::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::FineLevelInputDataFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IsorropiaInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::RigidBodyModeFactory< Scalar, 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::RebalanceMapFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::SingleLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RepartitionBlockDiagonalFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::DropNegativeEntriesFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedBlockedMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::FilteredAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::DemoFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::StructuredLineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NullspacePresmoothFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::TopSmootherFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

virtual void MueLu::SingleLevelFactoryBase::Build ( Level currentLevel) const
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::HybridAggregationFactory< 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::StructuredAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SubBlockAFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::NodePartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >, MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CloneRepartitionInterface< 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::FineLevelInputDataFactory< 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::RepartitionInterface< LocalOrdinal, GlobalOrdinal, Node >, MueLu::UserAggregationFactory< 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::RepartitionBlockDiagonalFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::StructuredLineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedBlockedMatrixFactory< 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 >.

virtual void MueLu::SingleLevelFactoryBase::CallBuild ( Level requestedLevel) const
inlinevirtual

Implements MueLu::FactoryBase.

Definition at line 97 of file MueLu_SingleLevelFactoryBase.hpp.

virtual void MueLu::SingleLevelFactoryBase::CallDeclareInput ( Level requestedLevel) const
inlinevirtual

Implements MueLu::FactoryBase.

Definition at line 147 of file MueLu_SingleLevelFactoryBase.hpp.


The documentation for this class was generated from the following file: