NOX::LineSearch::UserDefinedFactoryT< T > Class Template Reference

Concrete instantiation of a NOX::LineSearch::UserDefinedFactory object that uses the base objects only for constuction. More...

#include <NOX_LineSearch_UserDefinedFactoryT.H>

Inheritance diagram for NOX::LineSearch::UserDefinedFactoryT< T >:

Collaboration diagram for NOX::LineSearch::UserDefinedFactoryT< T >:

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

Detailed Description

template<typename T>
class NOX::LineSearch::UserDefinedFactoryT< T >

Concrete instantiation of a NOX::LineSearch::UserDefinedFactory object that uses the base objects only for constuction.

If the user writes their own line search and that object has the same constructor arguments as the nox line searches (the gd and params as in the buildDirection method), then users can use this object instead of having to write their own factory.

For example, if a user writes their own line search object:

class MyLineSearch : public NOX::LineSearch::Generic {

  // Ctor that takes the standard line search arguments.
  MyLineSearch(const Teuchos::RCP<NOX::GlobalData>& gd,
               Teuchos::ParameterList& params);

  .
  .
  .

}

They can build that object using this factory and do not have to write their own factory

ParameterList dl& = nox_params.sublist("Line Search");
RCP<NOX::LineSearch::UserDefinedFactory> udlsf =
  rcp(new NOX::LineSearch::UserDefinedFactoryT<MyLineSearch>);
dl.set("User Defined LineSearch Factory", udlsf);

It is critical that the user defined factory be set in the parameter list as a base class type object: NOX::LineSearch::UserDefinedFactory.

Member Function Documentation

template<typename T >

Teuchos::RCP<NOX::LineSearch::Generic> NOX::LineSearch::UserDefinedFactoryT< T >::buildLineSearch ( const Teuchos::RCP< NOX::GlobalData > &  gd, Teuchos::ParameterList &  params  ) const

inlinevirtual

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.

Implements NOX::LineSearch::UserDefinedFactory.

References rcp().

---

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

• NOX_LineSearch_UserDefinedFactoryT.H