MueLu
Version of the Day
|
Factory for building aggregates on meshes partly structured and partly unstructured. More...
#include <MueLu_HybridAggregationFactory_decl.hpp>
Private Attributes | |
std::vector< RCP < MueLu::AggregationAlgorithmBase < LocalOrdinal, GlobalOrdinal, Node > > > | algos_ |
aggregation algorithms More... | |
bool | bDefinitionPhase_ |
Constructors/Destructors. | |
HybridAggregationFactory () | |
Constructor. More... | |
virtual | ~HybridAggregationFactory () |
Destructor. More... | |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
void | DeclareInput (Level ¤tLevel) const |
Input. More... | |
Build methods. | |
void | Build (Level ¤tLevel) const |
Build aggregates. More... | |
Additional Inherited Members | |
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 |
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 |
Factory for building aggregates on meshes partly structured and partly unstructured.
Factory for creating aggregates from partly structured grids. The hybrid aggregation method returns an aggregate structure used by prolongator factories.
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 |
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
Graph | Factory | null | * | * | Generating factory for variable 'Graph' | |
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) | |
aggregationRegionType | Factory | null | * | * | Factory generating the type of aggregation to use on the region |
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 HybridAggregationFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see HybridAggregationFactory::DeclareInput).
After HybridAggregationFactory::Build the following data is available (if requested)
Parameter | generated by | description |
---|---|---|
Aggregates | HybridAggregationFactory | Container class with aggregation information. See also Aggregates. |
Definition at line 137 of file MueLu_HybridAggregationFactory_decl.hpp.
MueLu::HybridAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::HybridAggregationFactory | ( | ) |
Constructor.
Definition at line 88 of file MueLu_HybridAggregationFactory_def.hpp.
|
inlinevirtual |
Destructor.
Definition at line 149 of file MueLu_HybridAggregationFactory_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 93 of file MueLu_HybridAggregationFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 164 of file MueLu_HybridAggregationFactory_def.hpp.
|
virtual |
Build aggregates.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 251 of file MueLu_HybridAggregationFactory_def.hpp.
|
mutableprivate |
aggregation algorithms
Definition at line 174 of file MueLu_HybridAggregationFactory_decl.hpp.
|
mutableprivate |
boolean flag: definition phase if true, the aggregation algorithms still can be set and changed. if false, no change in aggregation algorithms is possible any more
Definition at line 179 of file MueLu_HybridAggregationFactory_decl.hpp.