NOX::Direction::UserDefinedFactory Class Reference

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

#include <NOX_Direction_UserDefinedFactory.H>

Inheritance diagram for NOX::Direction::UserDefinedFactory:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 UserDefinedFactory ()
 Constructor.
virtual ~UserDefinedFactory ()
 Destructor.
virtual Teuchos::RCP
< NOX::Direction::Generic
buildDirection (const Teuchos::RCP< NOX::GlobalData > &gd, Teuchos::ParameterList &params) const =0
 Builds a user defined direction object.


Detailed Description

Pure virtual interface for users to supply their own direction objects.

Definition at line 63 of file NOX_Direction_UserDefinedFactory.H.


Constructor & Destructor Documentation

NOX::Direction::UserDefinedFactory::UserDefinedFactory (  )  [inline]

Constructor.

Definition at line 68 of file NOX_Direction_UserDefinedFactory.H.

virtual NOX::Direction::UserDefinedFactory::~UserDefinedFactory (  )  [inline, virtual]

Destructor.

Definition at line 71 of file NOX_Direction_UserDefinedFactory.H.


Member Function Documentation

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

Builds a user defined direction object.

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

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


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

Generated on Thu Dec 17 11:03:04 2009 for Nonlinear Solver Project by  doxygen 1.5.9