Factory for building transfer operators based on coarsening in polynomial degree, following the Intrepid basis functions. More...

#include <MueLu_IntrepidPCoarsenFactory_decl.hpp>

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

Public Types
typedef Kokkos::DynRankView < LocalOrdinal, typename Node::device_type >	LOFieldContainer

typedef Kokkos::DynRankView < double, typename Node::device_type >	SCFieldContainer

typedef Intrepid2::Basis < typename Node::device_type::execution_space, double, double >	Basis

Private Member Functions
void	GenerateLinearCoarsening_pn_kirby_to_pm (const LOFieldContainer &hi_elemToNode, const std::vector< bool > &hi_nodeIsOwned, const SCFieldContainer &hi_DofCoords, const LOFieldContainer &lo_elemToHiRepresentativeNode, const Basis &lo_basis, const std::vector< LocalOrdinal > &hi_to_lo_map, const Teuchos::RCP< const Map > &lo_colMap, const Teuchos::RCP< const Map > &lo_domainMap, const Teuchos::RCP< const Map > &hi_map, Teuchos::RCP< Matrix > &P) const

Constructors/Destructors.
	IntrepidPCoarsenFactory ()
	Constructor. User can supply a factory for generating the tentative prolongator. More...

virtual	~IntrepidPCoarsenFactory ()
	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...

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

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

Internal Utilities
void	GenerateLinearCoarsening_pn_kirby_to_p1 (const LOFieldContainer &hi_elemToNode, const std::vector< bool > &hi_nodeIsOwned, const SCFieldContainer &hi_DofCoords, const std::vector< size_t > &lo_node_in_hi, const Basis &lo_Basis, const std::vector< LocalOrdinal > &hi_to_lo_map, const Teuchos::RCP< const Map > &lo_colMap, const Teuchos::RCP< const Map > &lo_domainMap, const Teuchos::RCP< const Map > &hi_map, Teuchos::RCP< Matrix > &P) const

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

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 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 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 = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building transfer operators based on coarsening in polynomial degree, following the Intrepid basis functions.

Input/output of IntrepidPCoarsenFactory

User parameters of IntrepidPCoarsenFactory

Parameter	type	default	master.xml	validated	description
pcoarsen: schedule	string	""	*	*	String describing the higher order coarsening scheme to use
pcoarsen: element	string	""	*	*	String describing the class of element to use for higher order coarsening
pcoarsen: hi basis	string	""	*	*	String describing higher-order basis function used
pcoarsen: lo basis	string	""	*	*	String describing lower-order basis function to be used for coarse grid
pcoarsen: element to node map	RCP<Intrepid::FieldContainer<LocalOrdinal> >	null	*	*	A FieldContainer with the element-to-node map in local ids compatible with the matrix column map
A	Factory	null	*	*	Generating factory of the matrix A used during the prolongator smoothing process

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

Variables provided by IntrepidPCoarsen

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

Parameter	generated by	description
P	IntrepidPCoarsenFactory	Smoothed prolongator

NOTE: The prolongator generated by this routine strips Dirichlet unknowns out of the coarse grid. This means that the prolongator cannot transfer solutions between grids, only updates (because the update at a Dirichlet node is zero). This is a subtle distinction, but an important one for testing purposes.

FIXME: There may be implications for the correctness of the nullspace transfer from fine to coarse that I need to understand.

Definition at line 115 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

Member Typedef Documentation

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

typedef Kokkos::DynRankView<LocalOrdinal,typename Node::device_type> MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::LOFieldContainer

Definition at line 120 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

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

typedef Kokkos::DynRankView<double,typename Node::device_type> MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SCFieldContainer

Definition at line 121 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

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

typedef Intrepid2::Basis<typename Node::device_type::execution_space,double,double> MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Basis

Definition at line 122 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

inline

Constructor. User can supply a factory for generating the tentative prolongator.

Definition at line 130 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 133 of file MueLu_IntrepidPCoarsenFactory_decl.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::IntrepidPCoarsenFactory< 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 704 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 721 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

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

virtual

Build method.

Builds IPC prolongator and returns it in coarseLevel.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 729 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

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

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 735 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

void MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GenerateLinearCoarsening_pn_kirby_to_p1	(	const LOFieldContainer &	hi_elemToNode,
		const std::vector< bool > &	hi_nodeIsOwned,
		const SCFieldContainer &	hi_DofCoords,
		const std::vector< size_t > &	lo_node_in_hi,
		const Basis &	lo_Basis,
		const std::vector< LocalOrdinal > &	hi_to_lo_map,
		const Teuchos::RCP< const Map > &	lo_colMap,
		const Teuchos::RCP< const Map > &	lo_domainMap,
		const Teuchos::RCP< const Map > &	hi_map,
		Teuchos::RCP< Matrix > &	P
	)		const

private

Definition at line 589 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

void MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GenerateLinearCoarsening_pn_kirby_to_pm	(	const LOFieldContainer &	hi_elemToNode,
		const std::vector< bool > &	hi_nodeIsOwned,
		const SCFieldContainer &	hi_DofCoords,
		const LOFieldContainer &	lo_elemToHiRepresentativeNode,
		const Basis &	lo_basis,
		const std::vector< LocalOrdinal > &	hi_to_lo_map,
		const Teuchos::RCP< const Map > &	lo_colMap,
		const Teuchos::RCP< const Map > &	lo_domainMap,
		const Teuchos::RCP< const Map > &	hi_map,
		Teuchos::RCP< Matrix > &	P
	)		const

private

Definition at line 648 of file MueLu_IntrepidPCoarsenFactory_def.hpp.

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

Public Types

Private Member Functions

Constructors/Destructors.

Build methods.

Internal Utilities

Additional Inherited Members

Detailed Description

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

Input/output of IntrepidPCoarsenFactory

User parameters of IntrepidPCoarsenFactory

Variables provided by IntrepidPCoarsen

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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