Factory for building tentative prolongator. More...

#include <MueLu_ReitzingerPFactory_decl.hpp>

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

Constructors/Destructors.
	ReitzingerPFactory ()
	Constructor.

virtual	~ReitzingerPFactory ()
	Destructor.

RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.

void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input.

Build methods.
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory.

void	BuildP (Level &fineLevel, Level &coarseLevel) const
	Abstract Build method.

void	CheckCommutingProperty (const Matrix &Pe, const Matrix &D0_c, const Matrix &D0_f, const Matrix &Pn) const
	Utility method.

Additional Inherited Members
Public Member Functions inherited from MueLu::PFactory
	PFactory ()
	Constructor.

virtual	~PFactory ()
	Destructor.

void	setRestrictionMode (bool bRestrictionMode=false)

bool	isRestrictionModeSet ()
	returns restrictionMode flag

Public Member Functions inherited from MueLu::TwoLevelFactoryBase
	TwoLevelFactoryBase ()
	Constructor.

virtual	~TwoLevelFactoryBase ()
	Destructor.

virtual void	CallDeclareInput (Level &requestedLevel) const

virtual void	CallBuild (Level &requestedLevel) const

Public Member Functions inherited from MueLu::Factory
	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

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor.

virtual	~FactoryBase ()
	Destructor.

int	GetID () const
	return unique factory id

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor.

Public Member Functions inherited from MueLu::VerboseObject
	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

Public Member Functions inherited from MueLu::Describable
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.

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.

virtual const Teuchos::ParameterList &	GetParameterList () const

virtual const Teuchos::ParameterList &	GetParameterListWithoutValidation () 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

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

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 Attributes inherited from MueLu::PFactory
bool	restrictionMode_

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::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building tentative prolongator.

Factory for creating Reitzinger and Schoebel tentative prolongator for Maxwell's equations.

Input/output of ReitzingerPFactory

User parameters of ReitzingerPFactory

Parameter	type	default	validated	requested	description
A	Factory	null	*	*	Generating factory of the matrix A
P	Factory	null	*	*	Generating factory of the nodal Prolongator
D0	Factory	null	*	*	Generating factory of the discrete gradient operator
NodeMatrix	Factory	null	*	*	Generating factory of the nodal A matrix

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

Variables provided by ReitzingerPFactory

After ReitzingerPFactory::Build the following data is available (if requested)

Parameter	generated by	description
P	ReitzingerPFactory	Non-smoothed "tentative" Reitzinger edge prolongation operator
D0	ReitzingerPFactory	Discrete gradient operator

Definition at line 69 of file MueLu_ReitzingerPFactory_decl.hpp.

Constructor & Destructor Documentation

◆ ReitzingerPFactory()

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

MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReitzingerPFactory ( )

inline

Constructor.

Definition at line 78 of file MueLu_ReitzingerPFactory_decl.hpp.

◆ ~ReitzingerPFactory()

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

virtual MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~ReitzingerPFactory ( )

inlinevirtual

Destructor.

Definition at line 81 of file MueLu_ReitzingerPFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

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

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.

Reimplemented from MueLu::Factory.

Definition at line 38 of file MueLu_ReitzingerPFactory_def.hpp.

◆ DeclareInput()

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

void MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput	(	Level &	fineLevel,
		Level &	coarseLevel
	)		const

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 63 of file MueLu_ReitzingerPFactory_def.hpp.

◆ Build()

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

void MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build	(	Level &	fineLevel,
		Level &	coarseLevel
	)		const

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 73 of file MueLu_ReitzingerPFactory_def.hpp.

◆ BuildP()

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

void MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildP	(	Level &	fineLevel,
		Level &	coarseLevel
	)		const

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 78 of file MueLu_ReitzingerPFactory_def.hpp.

◆ CheckCommutingProperty()

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

void MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CheckCommutingProperty	(	const Matrix &	Pe,
		const Matrix &	D0_c,
		const Matrix &	D0_f,
		const Matrix &	Pn
	)		const

Utility method.

Definition at line 482 of file MueLu_ReitzingerPFactory_def.hpp.

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

Constructors/Destructors.

Build methods.

Additional Inherited Members

Detailed Description

Input/output of ReitzingerPFactory

User parameters of ReitzingerPFactory

Variables provided by ReitzingerPFactory

Constructor & Destructor Documentation

◆ ReitzingerPFactory()

◆ ~ReitzingerPFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ BuildP()

◆ CheckCommutingProperty()