NOX  Development
Public Member Functions | List of all members
NOX::Direction::UserDefinedFactory Class Referenceabstract

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]

Public Member Functions

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

Detailed Description

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

Member Function Documentation

◆ buildDirection()

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
gdA 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.
paramsSublist with direction construction parameters.

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


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