#include <MueLu_Factory.hpp>

Inheritance diagram for MueLu::Factory:

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

void	EnableMultipleCallCheck () const

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

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

virtual	~FactoryBase ()
	Destructor. More...

virtual void	CallBuild (Level &requestedLevel) const =0

virtual void	CallDeclareInput (Level &requestedLevel) const =0

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

Static Public Member Functions
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 ()

Protected Member Functions
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

Static Protected Attributes
static bool	timerSync_ = false

	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

Additional Inherited Members
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

Definition at line 33 of file MueLu_Factory.hpp.

Constructor & Destructor Documentation

MueLu::Factory::Factory ( )

Constructor.

Definition at line 14 of file MueLu_Factory.cpp.

MueLu::Factory::~Factory ( )

virtualdefault

Destructor.

Member Function Documentation

void MueLu::Factory::SetFactory	(	const std::string &	varName,
		const RCP< const FactoryBase > &	factory
	)

virtual

Configuration.

SetFactory is for expert users only. To change configuration of the preconditioner, use a factory manager.

Implements MueLu::FactoryAcceptor.

Reimplemented in MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 25 of file MueLu_Factory.cpp.

const RCP< const FactoryBase > MueLu::Factory::GetFactory ( const std::string & varName ) const

virtual

Default implementation of FactoryAcceptor::GetFactory()

Implements MueLu::FactoryAcceptor.

Definition at line 30 of file MueLu_Factory.cpp.

RCP< ParameterList > MueLu::Factory::RemoveFactoriesFromList ( const ParameterList & list ) const

Definition at line 47 of file MueLu_Factory.cpp.

RCP< const ParameterList > MueLu::Factory::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 68 of file MueLu_Factory.cpp.

void MueLu::Factory::Input	(	Level &	level,
		const std::string &	varName
	)		const

protected

Definition at line 72 of file MueLu_Factory.cpp.

void MueLu::Factory::Input	(	Level &	level,
		const std::string &	varName,
		const std::string &	varParamName
	)		const

protected

Definition at line 76 of file MueLu_Factory.cpp.

template<class T >

T MueLu::Factory::Get	(	Level &	level,
		const std::string &	varName
	)		const

inlineprotected

Definition at line 69 of file MueLu_Factory.hpp.

template<class T >

T MueLu::Factory::Get	(	Level &	level,
		const std::string &	varName,
		const std::string &	varParamName
	)		const

inlineprotected

Definition at line 75 of file MueLu_Factory.hpp.

template<class T >

void MueLu::Factory::Set	(	Level &	level,
		const std::string &	varName,
		const T &	data
	)		const

inlineprotected

Definition at line 80 of file MueLu_Factory.hpp.

template<class T >

bool MueLu::Factory::IsType	(	Level &	level,
		const std::string &	varName
	)		const

inlineprotected

Definition at line 85 of file MueLu_Factory.hpp.

bool MueLu::Factory::IsAvailable	(	Level &	level,
		const std::string &	varName
	)		const

protected

Definition at line 80 of file MueLu_Factory.cpp.

void MueLu::Factory::EnableTimerSync ( )

static

Definition at line 84 of file MueLu_Factory.cpp.

void MueLu::Factory::DisableTimerSync ( )

static

Definition at line 86 of file MueLu_Factory.cpp.

void MueLu::Factory::EnableMultipleCallCheck ( ) const

Definition at line 120 of file MueLu_Factory.cpp.

void MueLu::Factory::DisableMultipleCallCheck ( ) const

Definition at line 121 of file MueLu_Factory.cpp.

void MueLu::Factory::ResetDebugData ( ) const

Definition at line 122 of file MueLu_Factory.cpp.

void MueLu::Factory::EnableMultipleCheckGlobally ( )

static

Definition at line 123 of file MueLu_Factory.cpp.

void MueLu::Factory::DisableMultipleCheckGlobally ( )

static

Definition at line 124 of file MueLu_Factory.cpp.

Member Data Documentation

bool MueLu::Factory::timerSync_ = false

staticprotected

Definition at line 96 of file MueLu_Factory.hpp.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation