#include <MueLu_Factory.hpp>

Inheritance diagram for MueLu::Factory:

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

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

int	GetID () const
	return unique factory id More...

virtual void	CallBuild (Level &requestedLevel) const =0

virtual void	CallDeclareInput (Level &requestedLevel) const =0

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

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

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. 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...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

Public Member Functions inherited from MueLu::FactoryAcceptor
virtual	~FactoryAcceptor ()

Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
	ParameterListAcceptorImpl ()

virtual	~ParameterListAcceptorImpl ()

virtual void	SetParameterList (const 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 ()

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	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

static void	SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)

static Teuchos::RCP< Teuchos::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

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

Static Protected Attributes
static bool	timerSync_ = false

Detailed Description

Definition at line 69 of file MueLu_Factory.hpp.

Constructor & Destructor Documentation

◆ Factory()

MueLu::Factory::Factory ( )

inline

Constructor.

Definition at line 75 of file MueLu_Factory.hpp.

◆ ~Factory()

virtual MueLu::Factory::~Factory ( )

inlinevirtual

Destructor.

Definition at line 82 of file MueLu_Factory.hpp.

Member Function Documentation

◆ SetFactory()

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

inlinevirtual

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 89 of file MueLu_Factory.hpp.

◆ GetFactory()

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

inlinevirtual

Default implementation of FactoryAcceptor::GetFactory()

Implements MueLu::FactoryAcceptor.

Definition at line 95 of file MueLu_Factory.hpp.

◆ RemoveFactoriesFromList()

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

inline

Definition at line 113 of file MueLu_Factory.hpp.

◆ GetValidParameterList()

virtual RCP<const ParameterList> MueLu::Factory::GetValidParameterList ( ) const

inlinevirtual

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 140 of file MueLu_Factory.hpp.

◆ Input() [1/2]

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

inlineprotected

Definition at line 146 of file MueLu_Factory.hpp.

◆ Input() [2/2]

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

inlineprotected

Definition at line 150 of file MueLu_Factory.hpp.

◆ Get() [1/2]

template<class T >

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

inlineprotected

Definition at line 155 of file MueLu_Factory.hpp.

◆ Get() [2/2]

template<class T >

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

inlineprotected

Definition at line 160 of file MueLu_Factory.hpp.

◆ Set()

template<class T >

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

inlineprotected

Definition at line 165 of file MueLu_Factory.hpp.

◆ IsAvailable()

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

inlineprotected

Definition at line 169 of file MueLu_Factory.hpp.

◆ EnableTimerSync()

static void MueLu::Factory::EnableTimerSync ( )

inlinestatic

Definition at line 174 of file MueLu_Factory.hpp.

◆ DisableTimerSync()

static void MueLu::Factory::DisableTimerSync ( )

inlinestatic

Definition at line 175 of file MueLu_Factory.hpp.

◆ EnableMultipleCallCheck()

void MueLu::Factory::EnableMultipleCallCheck ( ) const

inline

Definition at line 220 of file MueLu_Factory.hpp.

◆ DisableMultipleCallCheck()

void MueLu::Factory::DisableMultipleCallCheck ( ) const

inline

Definition at line 221 of file MueLu_Factory.hpp.

◆ ResetDebugData()

void MueLu::Factory::ResetDebugData ( ) const

inline

Definition at line 222 of file MueLu_Factory.hpp.

◆ EnableMultipleCheckGlobally()

static void MueLu::Factory::EnableMultipleCheckGlobally ( )

inlinestatic

Definition at line 223 of file MueLu_Factory.hpp.

◆ DisableMultipleCheckGlobally()

static void MueLu::Factory::DisableMultipleCheckGlobally ( )

inlinestatic

Definition at line 224 of file MueLu_Factory.hpp.

Member Data Documentation

◆ timerSync_

bool MueLu::Factory::timerSync_ = false

staticprotected

Definition at line 178 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

Detailed Description

Constructor & Destructor Documentation

◆ Factory()

◆ ~Factory()

Member Function Documentation

◆ SetFactory()

◆ GetFactory()

◆ RemoveFactoriesFromList()

◆ GetValidParameterList()

◆ Input() [1/2]

◆ Input() [2/2]

◆ Get() [1/2]

◆ Get() [2/2]

◆ Set()

◆ IsAvailable()

◆ EnableTimerSync()

◆ DisableTimerSync()

◆ EnableMultipleCallCheck()

◆ DisableMultipleCallCheck()

◆ ResetDebugData()

◆ EnableMultipleCheckGlobally()

◆ DisableMultipleCheckGlobally()

Member Data Documentation

◆ timerSync_