Factory for building aggregates for Lagrange multipliers in surface-coupled problems. More...

#include <MueLu_InterfaceAggregationFactory_decl.hpp>

Inheritance diagram for MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Private Member Functions
void	BuildBasedOnNodeMapping (const std::string &prefix, Level &currentLevel) const
	Build dual aggregates based on a given dual-to-primal node mapping. More...

void	BuildBasedOnPrimalInterfaceDofMap (const std::string &prefix, Level &currentLevel) const
	Build dual aggregates based on a given interface row map of the primal and dual problem. More...

RCP< const ParameterList >	GetValidParameterList () const override
	Input. More...

void	DeclareInput (Level &currentLevel) const override
	Specifies the data that this class needs, and the factories that generate that data. 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 FactoryBase >	GetFactory (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 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 ()

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...

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 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 >
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

template<class T >
bool	IsType (Level &level, const std::string &varName) const

bool	IsAvailable (Level &level, const std::string &varName) const

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

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 in surface-coupled problems.

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. 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.

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.

References

Wiesner, T. A.: Flexible Aggregation-based Algebraic Multigrid Methods for Contact and Flow Problems, PhD thesis, Technical University of Munich, 2015
Wiesner, T. A., Mayr, M., Popp, A., Gee, M. W., Wall, W. A.: Algebraic multigrid methods for saddle point systems arising from mortar contact formulations, Int. J. Numer. Methods Eng., 122(15):3749–3779, 2021, https://doi.org/10.1002/nme.6680

Input/output of this factory

User parameters of InterfaceAggregationFactory

Parameter	type	default	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() ).

Remarks

This factory support multiple dual/primal mapping strategies based on different inputs. They are:

node-based: 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.
dof-based: The row map of primal interface degrees of freedom (DOFs) is a subset of the row map of all primal DOFs. It only contains the primal DOFs of interface nodes, that also carry a Lagrange multiplier in the context of a mortar method.

Variables provided by this factory

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

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

overridevirtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 28 of file MueLu_InterfaceAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

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

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

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildBasedOnNodeMapping	(	const std::string &	prefix,
		Level &	currentLevel
	)		const

private

Build dual aggregates based on a given dual-to-primal node mapping.

Parameters

[in]	prefix	Prefix for screen output
	in/out]	currentLevel Level on which the aggregation needs to be performed

Definition at line 94 of file MueLu_InterfaceAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::InterfaceAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildBasedOnPrimalInterfaceDofMap	(	const std::string &	prefix,
		Level &	currentLevel
	)		const

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.

Note: In the context of mortar methods, the two maps correspond to the range and domain map of the slave-sided mortar operator \(D\), which connects primal interface unknowns and dual unknowns.

Parameters

[in]	prefix	Prefix for screen output
	in/out]	currentLevel Level on which the aggregation needs to be performed

Definition at line 190 of file MueLu_InterfaceAggregationFactory_def.hpp.

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

Private Member Functions

Build methods.

Additional Inherited Members

Detailed Description

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

Context, assumptions, and use cases

Idea

References

Input/output of this factory

User parameters of InterfaceAggregationFactory

Remarks

Variables provided by this factory

Member Function Documentation

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