NOX Development
Public Member Functions
NOX::Direction::Factory Class Reference

Factory to build direction objects derived from NOX::Direction::Generic. More...

#include <NOX_Direction_Factory.H>

List of all members.

Public Member Functions

 Factory ()
 ~Factory ()
< NOX::Direction::Generic
buildDirection (const Teuchos::RCP< NOX::GlobalData > &gd, Teuchos::ParameterList &params)
 Factory to build a direction object.

Detailed Description

Factory to build direction objects derived from NOX::Direction::Generic.


Using a User-Defined Direction

The user has the option of passing in a user-defined direction. First, they must implement their own direction, deriving from the base class interface NOX::Direction::Generic:

   class MyDirection : public NOX::Direction::Generic {
     // Ctor that takes the standard direction arguments.
     MyDirection(const Teuchos::RCP<NOX::GlobalData>& gd, 
                 Teuchos::ParameterList& params);



Next they must write a factory to build their object, deriving from the NOX::Direction::UserDefinedFactory base class interface:

class MyFactory {
   Teuchos::RCP<NOX::Direction::Generic> buildDirection(const Teuchos::RCP< NOX::GlobalData > &gd, Teuchos::ParameterList &params)

Then under the "Direction" parameter sublist, they need to set the method to "User Defined" and register the factory:

using namespace Teuchos; // for RCP and ParameterList
ParameterList& dir_params = p.sublist("Direction");
RCP<NOX::Direction::UserDefinedFactory> dir_facotry = rcp(new MyDirectionFactory);
dir_params.set("Method", "User Defined");
dir_params.set("User Defined Direction Factory", dir_factory);

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

Member Function Documentation

Teuchos::RCP< NOX::Direction::Generic > buildDirection ( const Teuchos::RCP< NOX::GlobalData > &  gd,
Teuchos::ParameterList params 

Factory to build a direction object.

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.

Nonmember function to build a direction object.

References Teuchos::ParameterList::get(), Teuchos::rcp(), and TEST_FOR_EXCEPTION.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends