|
MueLu
Version of the Day
|
|
MueLu
Version of the Day
|
Partitioning within a node onlyThis interface provides partitioning within a node. More...
#include <MueLu_NodePartitionInterface_decl.hpp>
Public Member Functions | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
 Public Member Functions inherited from MueLu::SingleLevelFactoryBase | |
| SingleLevelFactoryBase () | |
| Constructor. More... | |
| virtual | ~SingleLevelFactoryBase () |
| Destructor. More... | |
| virtual void | CallBuild (Level &requestedLevel) const |
| virtual void | CallDeclareInput (Level &requestedLevel) const |
| 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::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 Teuchos::VerboseObject< VerboseObject > | |
| VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
| virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
| virtual const VerboseObject & | setOverridingVerbLevel (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 VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
| virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
| virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
| virtual RCP< FancyOStream > | getOStream () const |
| virtual RCP< FancyOStream > | getOverridingOStream () 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 ¶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 |
| Public Member Functions inherited from MueLu::ParameterListAcceptor | |
| ParameterListAcceptor () | |
| virtual | ~ParameterListAcceptor ()=default |
Private Attributes | |
| RCP< ParameterList > | defaultNodePartitionParams |
Constructors/Destructors | |
| NodePartitionInterface () | |
| Constructor. More... | |
| virtual | ~NodePartitionInterface () |
| Destructor. More... | |
Input | |
| void | DeclareInput (Level ¤tLevel) const |
| Specifies the data that this class needs, and the factories that generate that data. More... | |
Build methods. | |
| void | Build (Level ¤tLevel) const |
| Build an object with this factory. More... | |
Additional Inherited Members | |
| 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< FancyOStream > | getDefaultOStream () |
| 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 |
Partitioning within a node only
This interface provides partitioning within a node.
| Parameter | type | default | master.xml | validated | requested | description |
|---|---|---|---|---|---|---|
| A | Factory | null | * | * | Generating factory of the matrix A used during the prolongator smoothing process | |
| Coordinates | Factory | null | * | (*) | Factory generating coordinates vector used for rebalancing. The coordinates are only needed when the chosen algorithm is 'multijagged' or 'rcb'. | |
| ParameterList | ParamterList | null | * | NodePartition parameters | ||
| number of partitions | GO | - | Short-cut parameter set by RepartitionFactory. Avoid repartitioning algorithms if only one partition is necessary (see details below) | |||
| NodeComm | Factory | null | * | (*) | Factory generating NodeComm. |
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 NodePartitionInterface::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see NodePartitionInterface::DeclareInput).
After NodePartitionInterface::Build the following data is available (if requested)
| Parameter | generated by | description |
|---|---|---|
| Partition | NodePartitionInterface | GOVector based on the Row map of A (DOF-based) containing the process id the DOF should be living in after rebalancing/repartitioning |
The "Partition" vector is used as input for the RepartitionFactory class. If Re-partitioning/rebalancing is necessary it uses the "Partition" variable to create the corresponding Xpetra::Import object which then is used by the RebalanceFactory classes (e.g., RebalanceAcFactory, RebalanceTransferFactory,...) to rebalance the coarse level operators.
The RepartitionHeuristicFactory calculates how many partitions are to be built when performing rebalancing. It stores the result in the "number of partitions" variable on the current level (type = GO). If it is "number of partitions=1" we skip the NodePartition call and just create an dummy "Partition" vector containing zeros only. If no repartitioning is necessary (i.e., just keep the current partitioning) we return "Partition = Teuchos::null". If "number of partitions" > 1, the algorithm tries to find the requested number of partitions.
Definition at line 113 of file MueLu_NodePartitionInterface_decl.hpp.
| MueLu::NodePartitionInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NodePartitionInterface | ( | ) |
Constructor.
Definition at line 67 of file MueLu_NodePartitionInterface_def.hpp.
|
inlinevirtual |
Destructor.
Definition at line 126 of file MueLu_NodePartitionInterface_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.
Implements MueLu::ParameterListAcceptor.
Definition at line 70 of file MueLu_NodePartitionInterface_def.hpp.
|
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.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 87 of file MueLu_NodePartitionInterface_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 95 of file MueLu_NodePartitionInterface_def.hpp.
|
private |
Definition at line 143 of file MueLu_NodePartitionInterface_decl.hpp.
1.8.5 
