Thyra::NonlinearSolverBuilderBase< Scalar > Class Template Reference

Abstract interface for an object that can create NonlinearSolverBase objects on demand. More...

#include <Thyra_NonlinearSolverBuilderBase.hpp>

Inheritance diagram for Thyra::NonlinearSolverBuilderBase< Scalar >:

List of all members.

Public Member Functions
virtual Teuchos::RCP < NonlinearSolverBase< Scalar > >	createNonlinearSolver (const std::string &nonlinearSolverTypeName) const =0
	Create a new NonlinearSolverBase object purely specified by the parameter list.
Private Member Functions
NonlinearSolverBuilderBase < Scalar > &	operator= (const NonlinearSolverBuilderBase< Scalar > &)
Related Functions
(Note that these are not member functions.)
template<class Scalar >
Teuchos::RCP < NonlinearSolverBase< Scalar > >	createNonlinearSolver (const NonlinearSolverBuilderBase< Scalar > &nonlinearSolverBuilder, const std::string &nonlinearSolverTypeName="")

---

Detailed Description

template<class Scalar>
class Thyra::NonlinearSolverBuilderBase< Scalar >

Abstract interface for an object that can create NonlinearSolverBase objects on demand.

ToDo: Finish documentation!

Definition at line 45 of file Thyra_NonlinearSolverBuilderBase.hpp.

---

Member Function Documentation

template<class Scalar>

virtual Teuchos::RCP<NonlinearSolverBase<Scalar> > Thyra::NonlinearSolverBuilderBase< Scalar >::createNonlinearSolver

(

const std::string &

nonlinearSolverTypeName

)

const [pure virtual]

Create a new NonlinearSolverBase object purely specified by the parameter list.

Parameters:

nonlinearSolverTypeName

[in] The optional name of the nonlinear solver strategy to create. The most typical use case will pass in an empty string but there will be cases where I client will want to try to select a specific linear solver strategy, even for just testing purposes.

This function is given no information about the nature of the nonlinear problem to be solved.

Implemented in Thyra::DefaultNonlinearSolverBuilder.

Referenced by Thyra::NonlinearSolverBuilderBase< Scalar >::createNonlinearSolver().

template<class Scalar>

NonlinearSolverBuilderBase<Scalar>& Thyra::NonlinearSolverBuilderBase< Scalar >::operator=

(

const NonlinearSolverBuilderBase< Scalar > &

)

[private]

---

Friends And Related Function Documentation

template<class Scalar >

Teuchos::RCP< NonlinearSolverBase< Scalar > > createNonlinearSolver	(	const NonlinearSolverBuilderBase< Scalar > &	nonlinearSolverBuilder,
		const std::string &	nonlinearSolverTypeName = ""
	)		[related]

Definition at line 78 of file Thyra_NonlinearSolverBuilderBase.hpp.

References Thyra::NonlinearSolverBuilderBase< Scalar >::createNonlinearSolver().

---

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

• Thyra_NonlinearSolverBuilderBase.hpp