Thyra Package Browser (Single Doxygen Collection) Version of the Day
Private Types | Private Member Functions | Private Attributes
Thyra::DefaultNonlinearSolverBuilder Class Reference

Concrete subclass of Thyra::NonlinearSolverBuilderBase for creating NonlinearSolverBase objects and PreconditionerFactoryBase object on demand given configured factory objects. More...

#include <Thyra_DefaultNonlinearSolverBuilder.hpp>

Inheritance diagram for Thyra::DefaultNonlinearSolverBuilder:
Inheritance graph
[legend]

List of all members.

Private Types

typedef RCP< const
AbstractFactory
< Thyra::NonlinearSolverBase
< double > > > 
ns_fcty_t

Private Member Functions

void initializeDefaults ()

Private Attributes

RCP< ParameterList > paramList_
RCP< const ParameterList > validParamList_
Array< std::string > validNonlinearSolverNames_
Array< ns_fcty_tnonlinearSolverArray_
std::string defaultNonlinearSolverName_

Constructors/Initializers/Accessors

 DefaultNonlinearSolverBuilder ()
 
 ~DefaultNonlinearSolverBuilder ()
 
void setNonlinearSolverFactory (const RCP< const AbstractFactory< Thyra::NonlinearSolverBase< double > > > &nonlinearSolverFactory, const std::string &nonlinearSolverTypeName)
 Set a new NonlinearSolverBase factory object.
std::string getNonlinearSolverName () const
 Get the name of the NonlinearSolver type that will be created on the next call to this->createNonlinearSolver().

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< ParameterList > getNonconstParameterList ()
 
RCP< ParameterList > unsetParameterList ()
 
RCP< const ParameterList > getParameterList () const
 
RCP< const ParameterList > getValidParameters () const
 

Overridden from NonlinearSolverBuilderBase.

virtual Teuchos::RCP
< NonlinearSolverBase< Scalar > > 
createNonlinearSolver (const std::string &nonlinearSolverTypeName) const
 

Detailed Description

Concrete subclass of Thyra::NonlinearSolverBuilderBase for creating NonlinearSolverBase objects and PreconditionerFactoryBase object on demand given configured factory objects.

ToDo: Finish Documentation!

Definition at line 48 of file Thyra_DefaultNonlinearSolverBuilder.hpp.


Member Typedef Documentation

typedef RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > > Thyra::DefaultNonlinearSolverBuilder::ns_fcty_t [private]

Definition at line 107 of file Thyra_DefaultNonlinearSolverBuilder.hpp.


Constructor & Destructor Documentation

Thyra::DefaultNonlinearSolverBuilder::DefaultNonlinearSolverBuilder ( )

Thyra::DefaultNonlinearSolverBuilder::~DefaultNonlinearSolverBuilder ( )


Member Function Documentation

void Thyra::DefaultNonlinearSolverBuilder::setNonlinearSolverFactory ( const RCP< const AbstractFactory< Thyra::NonlinearSolverBase< double > > > &  nonlinearSolverFactory,
const std::string &  nonlinearSolverTypeName 
)

Set a new NonlinearSolverBase factory object.

std::string Thyra::DefaultNonlinearSolverBuilder::getNonlinearSolverName ( ) const

Get the name of the NonlinearSolver type that will be created on the next call to this->createNonlinearSolver().

void Thyra::DefaultNonlinearSolverBuilder::setParameterList ( RCP< ParameterList > const &  paramList)

RCP<ParameterList> Thyra::DefaultNonlinearSolverBuilder::getNonconstParameterList ( )

RCP<ParameterList> Thyra::DefaultNonlinearSolverBuilder::unsetParameterList ( )

RCP<const ParameterList> Thyra::DefaultNonlinearSolverBuilder::getParameterList ( ) const

RCP<const ParameterList> Thyra::DefaultNonlinearSolverBuilder::getValidParameters ( ) const

virtual Teuchos::RCP<NonlinearSolverBase<Scalar> > Thyra::DefaultNonlinearSolverBuilder::createNonlinearSolver ( const std::string &  nonlinearSolverTypeName) const [virtual]
void Thyra::DefaultNonlinearSolverBuilder::initializeDefaults ( ) [private]

Member Data Documentation

Definition at line 112 of file Thyra_DefaultNonlinearSolverBuilder.hpp.

RCP<const ParameterList> Thyra::DefaultNonlinearSolverBuilder::validParamList_ [mutable, private]

Definition at line 113 of file Thyra_DefaultNonlinearSolverBuilder.hpp.

Definition at line 114 of file Thyra_DefaultNonlinearSolverBuilder.hpp.

Definition at line 115 of file Thyra_DefaultNonlinearSolverBuilder.hpp.

Definition at line 116 of file Thyra_DefaultNonlinearSolverBuilder.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines