MueLu Version of the Day
|
Factory for building aggregates for Lagrange multipliers in surface-coupled problems. More...
#include <MueLu_InterfaceAggregationFactory_decl.hpp>
Public Member Functions | |
RCP< const ParameterList > | GetValidParameterList () const override |
Input. | |
void | DeclareInput (Level ¤tLevel) const override |
Specifies the data that this class needs, and the factories that generate that data. | |
![]() | |
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 |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
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 () |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
Configuration. | |
virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
![]() | |
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 |
Build methods. | |
void | Build (Level ¤tLevel) const override |
Build aggregates. | |
void | BuildBasedOnNodeMapping (const std::string &prefix, Level ¤tLevel) const |
Build dual aggregates based on a given dual-to-primal node mapping. | |
void | BuildBasedOnPrimalInterfaceDofMap (const std::string &prefix, Level ¤tLevel) const |
Build dual aggregates based on a given interface row map of the primal and dual problem. | |
Additional Inherited Members | |
![]() | |
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 |
Factory for building aggregates for Lagrange multipliers in surface-coupled problems.
This factory is intended to be used for saddle-point systems of surface-coupled problems, where constraints are enforced with Lagrange multipliers. In addition to the primal unknowns, Lagrange multipliers are considered as dual unknowns. The presence of Lagrange multipliers make this a primal/dual problem.
It is assumed that each primal slave-side interface node (carrying primal unknowns) is replicated with a dual node carrying the dual unknowns. While the number of degrees of freedom (DOFs) per dual node is required to be constant for all dual nodes, the number of dual DOFs per node can differ from the number of primal DOFs per node.
This factory will generate aggregates for the dual nodes such that they "match" the aggregates of their primal counterpart. Instead of performing an actual aggregation procedure on the dual nodes, we grep the existing primal aggregates and use a user-given mapping of dual-to-primal node IDs to create the dual aggregates.
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
A | Factory | null | * | * | Generating factory of the matrix A | |
Aggregates | Factory | null | * | * | Generating factory of the aggregates (of type "Aggregates" produced, e.g., by the UncoupledAggregationFactory) | |
Dual/primal mapping strategy | string | vague | * | * | Chosen strategy and type of input data to generate dual/primal mappings | |
DualNodeID2PrimalNodeID | Factory | null | * | * | Generating factory of the fine dual-to-primal node mapping | |
Primal interface DOF map | Factory | null | * | * | Generating factory of the fine row map of primal interface degrees of freedom |
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 GetValidParameters()
).
The * in the requested
column states that the data is requested as input with all dependencies (see DeclareInput()
).
This factory support multiple dual/primal mapping strategies based on different inputs. They are:
DualNodeID2PrimalNodeID
, is of data type std::map<LocalOrdinal,LocalOrdinal>
. The 'key' refers to the local ID of the dual node, while the 'value' represents the local ID of its primal counterpart.After InterfaceAggregationFactory::Build the following data is available (if requested)
Parameter | generated by | description |
---|---|---|
Aggregates | InterfaceAggregationFactory | Aggregates of "dual nodes" carrying Lagrange multipliers in surface-coupled problems with primal and dual variables. |
CoarseDualNodeID2PrimalNodeID | InterfaceAggregationFactory | Coarsened mapping of dual node IDs two primal node IDs. |
Definition at line 125 of file MueLu_InterfaceAggregationFactory_decl.hpp.
|
overridevirtual |
Input.
Reimplemented from MueLu::Factory.
Definition at line 66 of file MueLu_InterfaceAggregationFactory_def.hpp.
|
overridevirtual |
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 88 of file MueLu_InterfaceAggregationFactory_def.hpp.
|
overridevirtual |
Build aggregates.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 123 of file MueLu_InterfaceAggregationFactory_def.hpp.
|
private |
Build dual aggregates based on a given dual-to-primal node mapping.
[in] | prefix | Prefix for screen output |
[in/out] | currentLevel Level on which the aggregation needs to be performed |
Definition at line 142 of file MueLu_InterfaceAggregationFactory_def.hpp.
|
private |
Build dual aggregates based on a given interface row map of the primal and dual problem.
The row map of the interface portion of the primal problem corresponds to the row map of the dual problem. This correspondence is exploited to form the dual aggregates based on available primal aggregates.
[in] | prefix | Prefix for screen output |
[in/out] | currentLevel Level on which the aggregation needs to be performed |
Definition at line 242 of file MueLu_InterfaceAggregationFactory_def.hpp.