Factory for building "unsmooshed" transfer operators from transfer operators associated with a scalar helper problem (built by the VariableDofLaplacianFactory) More...

#include <MueLu_UnsmooshFactory_decl.hpp>

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

Public Member Functions
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory. More...

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

Public Member Functions inherited from MueLu::PFactory
	PFactory ()
	Constructor. More...

virtual	~PFactory ()
	Destructor. More...

void	setRestrictionMode (bool bRestrictionMode=false)

bool	isRestrictionModeSet ()
	returns restrictionMode flag More...

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

virtual	~TwoLevelFactoryBase ()
	Destructor. More...

virtual void	CallDeclareInput (Level &requestedLevel) const

virtual void	CallBuild (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 &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

Constructors/Destructors.
	UnsmooshFactory ()
	Constructor. More...

virtual	~UnsmooshFactory ()
	Destructor. More...

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

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

Additional Inherited Members
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

Protected Attributes inherited from MueLu::PFactory
bool	restrictionMode_

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::UnsmooshFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building "unsmooshed" transfer operators from transfer operators associated with a scalar helper problem (built by the VariableDofLaplacianFactory)

The output prolongation operator P is compatible to the input matrix A. The input prolongation matrix P is supposed to be built by the VariableDofLaplacianFactory with 1 DOF per node. The DofStatus array declares for each row, whether it is a standard dof or a padded/pseudo Dirichlet dof. The user has to provide the parameter "maxDofPerNode", since the coarse matrices are always padded by construction (i.e. constant number of DOFs per node). This parameter is needed for building the column map of the unsmooshed prolongation operator. The parameter "fineIsPadded" allows to specify whether the input matrix A on the finest level is padded or not. In the padded case we have an artificially extended input matrix with pseudo Dirichlet rows on inactive rows. In the non-padded version we have "variable" number of Dofs per node.

Input/output of UnsmooshFactory

User parameters of UnsmooshFactory

Parameter	type	default	validated	requested	description
A	Factory	null	*	*	Generating factory of the input matrix A with potentially variable number of DOFs. Might be padded or non-padded. Padded means, that the matrix has additional artificial rows and columns to have a constant number of DOFs per node. Needed to match the row map for the unsmooshed version of P with the row map of the unamalgamated input matrix A.
P	Factory	null	*	*	Generating factory of the (amalgamated) prolongator P generated from a (pseudo Laplacian) with 1 Dofs per node. Will be unsmooshed to be compatible with input matrix A in this factory.
DofStatus	Facotry	null	*	*	Generating factory for dofStatus array (usually generated by the VariableDofLaplacdianFactory). It is a Teuchos::Array<char> of size number of Rows of input matrix P multiplied by the maximum possible number of Dofs per node.
maxDofPerNode	int	1	*		Maximum number of DOFs per node. Needed for generating unsmooshed P. Note, that the coarse matrices are always padded, i.e. we have constant number of DOFs per node.

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

Variables provided by UnsmooshFactory

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

Parameter	generated by	description
P	UnsmooshFactory	Unsmooshed prolongation operator

Definition at line 97 of file MueLu_UnsmooshFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

Constructor.

Definition at line 57 of file MueLu_UnsmooshFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

inlinevirtual

Destructor.

Definition at line 110 of file MueLu_UnsmooshFactory_decl.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::UnsmooshFactory< 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.

Implements MueLu::ParameterListAcceptor.

Definition at line 60 of file MueLu_UnsmooshFactory_def.hpp.

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 73 of file MueLu_UnsmooshFactory_def.hpp.

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 85 of file MueLu_UnsmooshFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

inlinevirtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 124 of file MueLu_UnsmooshFactory_decl.hpp.

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

Public Member Functions

Constructors/Destructors.

Additional Inherited Members

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType> class MueLu::UnsmooshFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Input/output of UnsmooshFactory

User parameters of UnsmooshFactory

Variables provided by UnsmooshFactory

Constructor & Destructor Documentation

Member Function Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::UnsmooshFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >