Factory that builds a restriction operator for region multigrid. More...

#include <MueLu_RegionRFactory_kokkos_decl.hpp>

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

Public Types
using	real_type = typename Teuchos::ScalarTraits< SC >::coordinateType

using	realvaluedmultivector_type = typename Xpetra::MultiVector< real_type, LO, GO, NO >

using	execution_space = typename Node::execution_space

using	memory_space = typename Node::memory_space

using	device_type = Kokkos::Device< execution_space, memory_space >

using	intTupleView = typename Kokkos::View< int[3], device_type >

using	LOTupleView = typename Kokkos::View< LO[3], device_type >

Constructors/Destructors.
	RegionRFactory_kokkos ()=default
	Default Constructor.

virtual	~RegionRFactory_kokkos ()=default
	Destructor.

RCP< const ParameterList >	GetValidParameterList () const
	Input.

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

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

void	Build3D (const int numDimensions, Array< LO > &lFineNodesPerDim, const RCP< Matrix > &A, const RCP< realvaluedmultivector_type > &fineCoordinates, RCP< Matrix > &R, RCP< realvaluedmultivector_type > &coarseCoordinates, Array< LO > &lCoarseNodesPerDim) const

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

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

Factory that builds a restriction operator for region multigrid.

Definition at line 33 of file MueLu_RegionRFactory_kokkos_decl.hpp.

Member Typedef Documentation

◆ real_type

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::real_type = typename Teuchos::ScalarTraits<SC>::coordinateType

Definition at line 38 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ realvaluedmultivector_type

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::realvaluedmultivector_type = typename Xpetra::MultiVector<real_type, LO, GO, NO>

Definition at line 39 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ execution_space

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::execution_space = typename Node::execution_space

Definition at line 40 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ memory_space

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::memory_space = typename Node::memory_space

Definition at line 41 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ device_type

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::device_type = Kokkos::Device<execution_space, memory_space>

Definition at line 42 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ intTupleView

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::intTupleView = typename Kokkos::View<int[3], device_type>

Definition at line 43 of file MueLu_RegionRFactory_kokkos_decl.hpp.

◆ LOTupleView

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

using MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::LOTupleView = typename Kokkos::View<LO[3], device_type>

Definition at line 44 of file MueLu_RegionRFactory_kokkos_decl.hpp.

Constructor & Destructor Documentation

◆ RegionRFactory_kokkos()

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

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

default

Default Constructor.

◆ ~RegionRFactory_kokkos()

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

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

virtualdefault

Destructor.

Member Function Documentation

◆ GetValidParameterList()

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

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

virtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 25 of file MueLu_RegionRFactory_kokkos_def.hpp.

◆ DeclareInput()

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

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

virtual

Input.

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

Definition at line 45 of file MueLu_RegionRFactory_kokkos_def.hpp.

◆ Build()

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 56 of file MueLu_RegionRFactory_kokkos_def.hpp.

◆ Build3D()

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

void MueLu::RegionRFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build3D	(	const int	numDimensions,
		Array< LO > &	lFineNodesPerDim,
		const RCP< Matrix > &	A,
		const RCP< realvaluedmultivector_type > &	fineCoordinates,
		RCP< Matrix > &	R,
		RCP< realvaluedmultivector_type > &	coarseCoordinates,
		Array< LO > &	lCoarseNodesPerDim
	)		const

Definition at line 156 of file MueLu_RegionRFactory_kokkos_def.hpp.

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

Public Types

Constructors/Destructors.

Build methods.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ real_type

◆ realvaluedmultivector_type

◆ execution_space

◆ memory_space

◆ device_type

◆ intTupleView

◆ LOTupleView

Constructor & Destructor Documentation

◆ RegionRFactory_kokkos()

◆ ~RegionRFactory_kokkos()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ Build3D()