NOX::LineSearch::UserDefinedFactory Class Reference

Pure virtual interface for users to supply their own line search objects. More...

#include <NOX_LineSearch_UserDefinedFactory.H>

Inheritance diagram for NOX::LineSearch::UserDefinedFactory:

[legend]List of all members.

Public Member Functions
	UserDefinedFactory ()
	Constructor.
virtual	~UserDefinedFactory ()
	Destructor.
virtual Teuchos::RCP< NOX::LineSearch::Generic >	buildLineSearch (const Teuchos::RCP< NOX::GlobalData > &gd, Teuchos::ParameterList &params) const =0
	Builds a user defined line search object.

---

Detailed Description

Pure virtual interface for users to supply their own line search objects.

---

Member Function Documentation

virtual Teuchos::RCP<NOX::LineSearch::Generic> NOX::LineSearch::UserDefinedFactory::buildLineSearch	(	const Teuchos::RCP< NOX::GlobalData > &	gd,
		Teuchos::ParameterList &	params
	)			const [pure virtual]

Builds a user defined line search object.

Parameters:

	gd	A global data pointer that contains the top level parameter list. Without storing this inside the line searchobject, there is no guarantee that the second parameter params will still exist. It can be deleted by the top level RCP.
	params	Sublist with line search construction parameters.

Implemented in NOX::LineSearch::UserDefinedFactoryT< T >.

---

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

• NOX_LineSearch_UserDefinedFactory.H

---