MueLu  Version of the Day
MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for building coarse matrices. More...

#include <MueLu_RebalanceAcFactory_decl.hpp>

Inheritance diagram for MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::TwoLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Private Attributes

std::vector< RCP< const FactoryBase > > rebalanceFacts_
 list of user-defined rebalancing Factories More...
 

Constructors/Destructors.

 RebalanceAcFactory ()
 
virtual ~RebalanceAcFactory ()
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

Input

void DeclareInput (Level &fineLevel, Level &coarseLevel) const
 Input. More...
 

Build methods.

void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory. More...
 
void AddRebalanceFactory (const RCP< const FactoryBase > &factory)
 Add rebalancing factory in the end of list of rebalancing factories in RebalanceAcFactory. More...
 
size_t NumRebalanceFactories () const
 Returns number of transfer factories. More...
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::TwoLevelFactoryBase
 TwoLevelFactoryBase ()
 Constructor. More...
 
virtual ~TwoLevelFactoryBase ()
 Destructor. More...
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
virtual void CallBuild (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
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 FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) 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::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...
 
- 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 MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()
 
virtual void SetParameterList (const 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 ParameterEntry & GetParameter (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 ()
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
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...
 
- Protected Member Functions inherited from MueLu::Factory
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 >
Get (Level &level, const std::string &varName) const
 
template<class 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
 

Detailed Description

template<class Scalar = Xpetra::Matrix<>::scalar_type, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building coarse matrices.

Definition at line 74 of file MueLu_RebalanceAcFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar = Xpetra::Matrix<>::scalar_type, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RebalanceAcFactory ( )
inline

Definition at line 82 of file MueLu_RebalanceAcFactory_decl.hpp.

template<class Scalar = Xpetra::Matrix<>::scalar_type, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~RebalanceAcFactory ( )
inlinevirtual

Definition at line 84 of file MueLu_RebalanceAcFactory_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
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.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level fineLevel,
Level coarseLevel 
) const
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 78 of file MueLu_RebalanceAcFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level fineLevel,
Level coarseLevel 
) const
virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 84 of file MueLu_RebalanceAcFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
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 144 of file MueLu_RebalanceAcFactory_def.hpp.

template<class Scalar = Xpetra::Matrix<>::scalar_type, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
size_t MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumRebalanceFactories ( ) const
inline

Returns number of transfer factories.

Definition at line 110 of file MueLu_RebalanceAcFactory_decl.hpp.

Member Data Documentation

template<class Scalar = Xpetra::Matrix<>::scalar_type, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
std::vector<RCP<const FactoryBase> > MueLu::RebalanceAcFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rebalanceFacts_
private

list of user-defined rebalancing Factories

Definition at line 116 of file MueLu_RebalanceAcFactory_decl.hpp.


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