MueLu::ParameterListAcceptorImpl Class Reference

#include <MueLu_ParameterListAcceptor.hpp>

Inheritance diagram for MueLu::ParameterListAcceptorImpl:

Public Member Functions
	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
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
	ParameterListAcceptor ()
virtual	~ParameterListAcceptor ()=default
virtual Teuchos::RCP< const Teuchos::ParameterList >	GetValidParameterList () const =0
	Return a const parameter list of valid parameters that setParameterList() will accept.

Private Attributes
Teuchos::ParameterList	paramList_

Detailed Description

Definition at line 91 of file MueLu_ParameterListAcceptor.hpp.

Constructor & Destructor Documentation

ParameterListAcceptorImpl()

MueLu::ParameterListAcceptorImpl::ParameterListAcceptorImpl

(

)

Definition at line 16 of file MueLu_ParameterListAcceptor.cpp.

~ParameterListAcceptorImpl()

virtual MueLu::ParameterListAcceptorImpl::~ParameterListAcceptorImpl ( )

virtualdefault

Member Function Documentation

SetParameterList()

void MueLu::ParameterListAcceptorImpl::SetParameterList ( const Teuchos::ParameterList & paramList )

virtual

Set parameters from a parameter list and return with default values.

Implements MueLu::ParameterListAcceptor.

Reimplemented in MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::IfpackSmoother< Node >, MueLu::IfpackSmoother< Node >, MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 18 of file MueLu_ParameterListAcceptor.cpp.

GetParameterList()

const Teuchos::ParameterList & MueLu::ParameterListAcceptorImpl::GetParameterList ( ) const

virtual

Implements MueLu::ParameterListAcceptor.

Definition at line 41 of file MueLu_ParameterListAcceptor.cpp.

SetParameter()

void MueLu::ParameterListAcceptorImpl::SetParameter ( const std::string & name, const ParameterEntry & entry )

virtual

Set a parameter directly as a ParameterEntry.

Implements MueLu::ParameterListAcceptor.

Definition at line 64 of file MueLu_ParameterListAcceptor.cpp.

GetParameter()

const ParameterEntry & MueLu::ParameterListAcceptorImpl::GetParameter ( const std::string & name ) const

virtual

Retrieves a const entry with the name name.

Implements MueLu::ParameterListAcceptor.

Definition at line 70 of file MueLu_ParameterListAcceptor.cpp.

GetDocumentation()

void MueLu::ParameterListAcceptorImpl::GetDocumentation ( std::ostream & os ) const

virtual

Implements MueLu::ParameterListAcceptor.

Definition at line 74 of file MueLu_ParameterListAcceptor.cpp.

Member Data Documentation

paramList_

Teuchos::ParameterList MueLu::ParameterListAcceptorImpl::paramList_

mutableprivate

Definition at line 114 of file MueLu_ParameterListAcceptor.hpp.

---

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

• MueLu_ParameterListAcceptor.hpp
• MueLu_ParameterListAcceptor.cpp