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

Factory for building aggregates for Lagrange multipliers. More...

#include <MueLu_InterfaceAggregationFactory_decl.hpp>

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

Constructors/Destructors.

 InterfaceAggregationFactory ()=default
 Constructor. More...
 
 ~InterfaceAggregationFactory ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const override
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
void DeclareInput (Level &currentLevel) const override
 Input. More...
 

Build methods.

void Build (Level &currentLevel) const override
 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
 
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 ()=default
 
virtual void SetParameterList (const Teuchos::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 ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
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...
 
- 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
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building aggregates for Lagrange multipliers.

Context, assumptions, and use cases

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. Furthermore, the number of degrees of freedom per dual node is required to constant for all dual nodes.

Idea

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.

Input/output of InterfaceAggregationFactory

User parameters of InterfaceAggregationFactory

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)
DualNodeID2PrimalNodeID Factory null * * Generating factory of the fine dual-to-primal node mapping

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 InterfaceAggregationFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see InterfaceAggregationFactory::DeclareInput).

The mapping of dual-to-primal node IDs, 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.

Variables provided by InterfaceAggregationFactory

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 110 of file MueLu_InterfaceAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ InterfaceAggregationFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InterfaceAggregationFactory ( )
default

Constructor.

◆ ~InterfaceAggregationFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~InterfaceAggregationFactory ( )
inline

Destructor.

Definition at line 123 of file MueLu_InterfaceAggregationFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
overridevirtual

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 60 of file MueLu_InterfaceAggregationFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
overridevirtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 74 of file MueLu_InterfaceAggregationFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
overridevirtual

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 96 of file MueLu_InterfaceAggregationFactory_def.hpp.


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