|
| SingleLevelFactoryBase () |
| Constructor.
|
|
virtual | ~SingleLevelFactoryBase () |
| Destructor.
|
|
virtual void | CallBuild (Level &requestedLevel) const |
|
virtual void | CallDeclareInput (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 |
|
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 () |
|
| 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 |
|
template<class
LocalOrdinal = DefaultLocalOrdinal, class
GlobalOrdinal = DefaultGlobalOrdinal, class
Node = DefaultNode>
class MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >
Factory for building uncoupled aggregates.
Factory for creating uncoupled aggregates from the amalgamated graph of A. The uncoupled aggregation method uses several aggregation phases which put together all nodes into aggregates.
Aggregation phases
Internally, each node has a status which can be one of the following:
Node status | Meaning |
READY | Node is not aggregated and can be used for building a new aggregate or can be added to an existing aggregate. |
AGGREGATED | Node is aggregated. |
IGNORED | Node is not considered for aggregation (it may have been dropped or put into a singleton aggregate) |
BOUNDARY | Node is a Dirichlet boundary node (with one or more Dirichlet boundary conditions). |
ONEPT | The user forces the aggregation algorithm to treat the node as a singleton. Important: Do not forget to set aggregation: allow user-specified singletons to true! Otherwise Phase3 will just handle the ONEPT nodes and probably not build singletons |
Input/output of UncoupledAggregationFactory
User parameters of UncoupledAggregationFactory
Parameter | type | default | master.xml | validated | requested | description |
Graph | Factory | null | | * | * | Generating factory of the graph of A |
DofsPerNode | Factory | null | | * | * | Generating factory for variable 'DofsPerNode', usually the same as for 'Graph' |
OnePt aggregate map name | string | | | * | * | Name of input map for single node aggregates (default=''). Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true. |
OnePt aggregate map factory | Factory | null | | * | * | Generating factory of (DOF) map for single node aggregates. Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true. |
aggregation: max agg size | int | see master.xml | * | * | | Maximum number of nodes per aggregate. |
aggregation: min agg size | int | see master.xml | * | * | | Minimum number of nodes necessary to build a new aggregate. |
aggregation: max selected neighbors | int | see master.xml | * | * | | Maximum number of neighbor nodes already in aggregate (needed in Phase1) |
aggregation: ordering | string | "natural" | * | * | | Ordering of node aggregation (can be either "natural", "graph" or "random"). |
aggregation: enable phase 1 | bool | true | * | * | | Turn on/off phase 1 aggregation |
aggregation: enable phase 2a | bool | true | * | * | | Turn on/off phase 2a aggregation |
aggregation: enable phase 2b | bool | true | * | * | | Turn on/off phase 2b aggregation |
aggregation: enable phase 3 | bool | true | * | * | | Turn on/off phase 3 aggregation |
aggregation: preserve Dirichlet points | bool | false | * | * | | preserve Dirichlet points as singleton nodes (default=false, i.e., drop Dirichlet nodes during aggregation) |
aggregation: allow user-specified singletons | bool | false | * | * | | Turn on/off OnePtAggregationAlgorithm (default=false) |
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 UncoupledAggregationFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see UncoupledAggregationFactory::DeclareInput).
Variables provided by UncoupledAggregationFactory
After UncoupledAggregationFactory::Build the following data is available (if requested)
Factory for creating uncoupled aggregates from the amalgamated graph of A. The uncoupled aggregation method uses several aggregation phases which put together all nodes into aggregates.
Aggregation phases
Internally, each node has a status which can be one of the following:
Node status | Meaning |
READY | Node is not aggregated and can be used for building a new aggregate or can be added to an existing aggregate. |
AGGREGATED | Node is aggregated. |
IGNORED | Node is not considered for aggregation (it may have been dropped or put into a singleton aggregate) |
BOUNDARY | Node is a Dirichlet boundary node (with one or more Dirichlet boundary conditions). |
ONEPT | The user forces the aggregation algorithm to treat the node as a singleton. Important: Do not forget to set aggregation: allow user-specified singletons to true! Otherwise Phase3 will just handle the ONEPT nodes and probably not build singletons |
Input/output of UncoupledAggregationFactory
User parameters of UncoupledAggregationFactory
Parameter | type | default | master.xml | validated | requested | description |
Graph | Factory | null | | * | * | Generating factory of the graph of A |
DofsPerNode | Factory | null | | * | * | Generating factory for variable 'DofsPerNode', usually the same as for 'Graph' |
OnePt aggregate map name | string | | | * | * | Name of input map for single node aggregates (default=''). Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true. |
OnePt aggregate map factory | Factory | null | | * | * | Generating factory of (DOF) map for single node aggregates. Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true. |
aggregation: max agg size | int | see master.xml | * | * | | Maximum number of nodes per aggregate. |
aggregation: min agg size | int | see master.xml | * | * | | Minimum number of nodes necessary to build a new aggregate. |
aggregation: max selected neighbors | int | see master.xml | * | * | | Maximum number of neighbor nodes already in aggregate (needed in Phase1) |
aggregation: ordering | string | "natural" | * | * | | Ordering of node aggregation (can be either "natural", "graph" or "random"). |
aggregation: enable phase 1 | bool | true | * | * | | Turn on/off phase 1 aggregation |
aggregation: enable phase 2a | bool | true | * | * | | Turn on/off phase 2a aggregation |
aggregation: enable phase 2b | bool | true | * | * | | Turn on/off phase 2b aggregation |
aggregation: enable phase 3 | bool | true | * | * | | Turn on/off phase 3 aggregation |
aggregation: preserve Dirichlet points | bool | false | * | * | | preserve Dirichlet points as singleton nodes (default=false, i.e., drop Dirichlet nodes during aggregation) |
aggregation: allow user-specified singletons | bool | false | * | * | | Turn on/off OnePtAggregationAlgorithm (default=false) |
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 UncoupledAggregationFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see UncoupledAggregationFactory::DeclareInput).
Variables provided by UncoupledAggregationFactory
After UncoupledAggregationFactory::Build the following data is available (if requested)
Definition at line 145 of file MueLu_UncoupledAggregationFactory_decl.hpp.