Prolongator factory performing geometric coarsening. More...

#include <MueLu_BlackBoxPFactory_decl.hpp>

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

Classes
struct	NodeID

struct	NodesIDs

Public Member Functions
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept. 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

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

Private Member Functions
void	GetGeometricData (RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &coordinates, const Array< LO > coarseRate, const Array< GO > gFineNodesPerDir, const Array< LO > lFineNodesPerDir, const LO BlkSize, Array< GO > &gIndices, Array< LO > &myOffset, Array< bool > &ghostInterface, Array< LO > &endRate, Array< GO > &gCoarseNodesPerDir, Array< LO > &lCoarseNodesPerDir, Array< LO > &glCoarseNodesPerDir, Array< GO > &ghostGIDs, Array< GO > &coarseNodesGIDs, Array< GO > &colGIDs, GO &gNumCoarseNodes, LO &lNumCoarseNodes, ArrayRCP< Array< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > > coarseNodes, Array< int > &boundaryFlags, RCP< NodesIDs > ghostedCoarseNodes) const

void	ComputeLocalEntries (const RCP< const Matrix > &Aghost, const Array< LO > coarseRate, const Array< LO > endRate, const LO BlkSize, const Array< LO > elemInds, const Array< LO > lCoarseElementsPerDir, const LO numDimensions, const Array< LO > lFineNodesPerDir, const Array< GO > gFineNodesPerDir, const Array< GO > gIndices, const Array< LO > lCoarseNodesPerDir, const Array< bool > ghostInterface, const Array< int > elementFlags, const std::string stencilType, const std::string blockStrategy, const Array< LO > elementNodesPerDir, const LO numNodesInElement, const Array< GO > colGIDs, Teuchos::SerialDenseMatrix< LO, SC > &Pi, Teuchos::SerialDenseMatrix< LO, SC > &Pf, Teuchos::SerialDenseMatrix< LO, SC > &Pe, Array< LO > &dofType, Array< LO > &lDofInd) const

void	CollapseStencil (const int type, const int orientation, const int collapseFlags[3], Array< SC > &stencil) const

void	FormatStencil (const LO BlkSize, const Array< bool > ghostInterface, const LO ie, const LO je, const LO ke, const ArrayView< const SC > rowValues, const Array< LO > elementNodesPerDir, const int collapseFlags[3], const std::string stencilType, Array< SC > &stencil) const

void	GetNodeInfo (const LO ie, const LO je, const LO ke, const Array< LO > elementNodesPerDir, int type, LO &ind, int orientation) const

void	sh_sort_permute (const typename Teuchos::Array< LocalOrdinal >::iterator &first1, const typename Teuchos::Array< LocalOrdinal >::iterator &last1, const typename Teuchos::Array< LocalOrdinal >::iterator &first2, const typename Teuchos::Array< LocalOrdinal >::iterator &last2) const

Friends
class	MueLuTests::BlackBoxPFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >

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

virtual	~BlackBoxPFactory ()
	Destructor. More...

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

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

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

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

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

Prolongator factory performing geometric coarsening.

The geometric algorithm assumes the underlying mesh is reasonably structured. Any rate of coarsening can be applied, and the rate is automatically decrease along an edge if the number of element is not divisible by the coarsening rate. The coarsening rate is allowed to be different in all direction which means that semi-coarsening can be achieved within this algorithm in 1 or 2 directions. The main difficulty is to obtain the number of elements/nodes in each directions to identify coarse nodes and fine nodes.

Input/output of BlackBoxPFactory

User parameters of SemiCoarsenPFactory

Parameter	type	default	validated	requested	description
Coarsen	string	-1			A string that specify the coarsening rate, if it is a single character, it will
					indicate a unique coarsening rate in each direction, if it is longer, it will be
					processed as a vector with 3 entries, one for each spatial direction
A	Factory	null	*	*	Generating factory of the matrix A used during the prolongator smoothing process
Nullspace	Factory	null	*	*	Generating factory of the nullspace. The GeneralGeometricPFactory provides
					a coarse version of the given Nullspace.
Coordinates	Factory	NoFactory	*	*	Generating factory for coorindates. The coordinates are expected to be provided
					on the finest level using the NoFactory mechanism. The coordinates are used to
					compute the coarsening stencil and coarse coordinates are generated for the next
					level.

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

Variables provided by BlackBoxPFactory

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

Parameter	generated by	description
P	BlackBoxPFactory	Prolongator
Nullspace	BlackBoxPFactory	Coarse nullspace (the fine level nullspace information is coarsened using P to generate a coarse version
		of the nullspace. No scaling is applied.
coarseCoordinates	BlackBoxPFactory	coarseCoordinates are to be picked up on the coarse level by the coordinates transfer factory and renamed
		coordinates so that on coarser levels coordinates are available in case another factory needs them.

Definition at line 84 of file MueLu_BlackBoxPFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

inline

Constructor.

Definition at line 95 of file MueLu_BlackBoxPFactory_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 98 of file MueLu_BlackBoxPFactory_decl.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::BlackBoxPFactory< 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_BlackBoxPFactory_def.hpp.

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 59 of file MueLu_BlackBoxPFactory_def.hpp.

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 93 of file MueLu_BlackBoxPFactory_def.hpp.

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

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

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 99 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetGeometricData	(	RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &	coordinates,
		const Array< LO >	coarseRate,
		const Array< GO >	gFineNodesPerDir,
		const Array< LO >	lFineNodesPerDir,
		const LO	BlkSize,
		Array< GO > &	gIndices,
		Array< LO > &	myOffset,
		Array< bool > &	ghostInterface,
		Array< LO > &	endRate,
		Array< GO > &	gCoarseNodesPerDir,
		Array< LO > &	lCoarseNodesPerDir,
		Array< LO > &	glCoarseNodesPerDir,
		Array< GO > &	ghostGIDs,
		Array< GO > &	coarseNodesGIDs,
		Array< GO > &	colGIDs,
		GO &	gNumCoarseNodes,
		LO &	lNumCoarseNodes,
		ArrayRCP< Array< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > >	coarseNodes,
		Array< int > &	boundaryFlags,
		RCP< NodesIDs >	ghostedCoarseNodes
	)		const

private

Definition at line 716 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ComputeLocalEntries	(	const RCP< const Matrix > &	Aghost,
		const Array< LO >	coarseRate,
		const Array< LO >	endRate,
		const LO	BlkSize,
		const Array< LO >	elemInds,
		const Array< LO >	lCoarseElementsPerDir,
		const LO	numDimensions,
		const Array< LO >	lFineNodesPerDir,
		const Array< GO >	gFineNodesPerDir,
		const Array< GO >	gIndices,
		const Array< LO >	lCoarseNodesPerDir,
		const Array< bool >	ghostInterface,
		const Array< int >	elementFlags,
		const std::string	stencilType,
		const std::string	blockStrategy,
		const Array< LO >	elementNodesPerDir,
		const LO	numNodesInElement,
		const Array< GO >	colGIDs,
		Teuchos::SerialDenseMatrix< LO, SC > &	Pi,
		Teuchos::SerialDenseMatrix< LO, SC > &	Pf,
		Teuchos::SerialDenseMatrix< LO, SC > &	Pe,
		Array< LO > &	dofType,
		Array< LO > &	lDofInd
	)		const

private

Definition at line 1309 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CollapseStencil	(	const int	type,
		const int	orientation,
		const int	collapseFlags[3],
		Array< SC > &	stencil
	)		const

private

Definition at line 1591 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FormatStencil	(	const LO	BlkSize,
		const Array< bool >	ghostInterface,
		const LO	ie,
		const LO	je,
		const LO	ke,
		const ArrayView< const SC >	rowValues,
		const Array< LO >	elementNodesPerDir,
		const int	collapseFlags[3],
		const std::string	stencilType,
		Array< SC > &	stencil
	)		const

private

Definition at line 1670 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetNodeInfo	(	const LO	ie,
		const LO	je,
		const LO	ke,
		const Array< LO >	elementNodesPerDir,
		int *	type,
		LO &	ind,
		int *	orientation
	)		const

private

Definition at line 1791 of file MueLu_BlackBoxPFactory_def.hpp.

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

void MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sh_sort_permute	(	const typename Teuchos::Array< LocalOrdinal >::iterator &	first1,
		const typename Teuchos::Array< LocalOrdinal >::iterator &	last1,
		const typename Teuchos::Array< LocalOrdinal >::iterator &	first2,
		const typename Teuchos::Array< LocalOrdinal >::iterator &	last2
	)		const

private

Definition at line 1860 of file MueLu_BlackBoxPFactory_def.hpp.

Friends And Related Function Documentation

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

friend class MueLuTests::BlackBoxPFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >

friend

Definition at line 89 of file MueLu_BlackBoxPFactory_decl.hpp.

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

Classes

Public Member Functions

Private Member Functions

Friends

Constructors/Destructors.

Build methods.

Additional Inherited Members

Detailed Description

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

Input/output of BlackBoxPFactory

User parameters of SemiCoarsenPFactory

Variables provided by BlackBoxPFactory

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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