NOX Development
Public Member Functions | Protected Attributes
LOCA::StepSize::Factory Class Reference

Factory for creating step size control strategy objects. More...

#include <LOCA_StepSize_Factory.H>

Collaboration diagram for LOCA::StepSize::Factory:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Factory (const Teuchos::RCP< LOCA::GlobalData > &global_data)
 Constructor.
virtual ~Factory ()
 Destructor.
Teuchos::RCP
< LOCA::StepSize::AbstractStrategy
create (const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &stepsizeParams)
 Create step size control strategy.
const string & strategyName (Teuchos::ParameterList &stepsizeParams) const
 Return strategy name given by stepsizeParams.

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 Global data.

Detailed Description

Factory for creating step size control strategy objects.

The parameters passed to the create() through the stepsizeParams argument method should specify the "Method" as described below, as well as any additional parameters for the particular strategy.


Member Function Documentation

Teuchos::RCP< LOCA::StepSize::AbstractStrategy > LOCA::StepSize::Factory::create ( const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  stepsizeParams 
)

Create step size control strategy.

Parameters:
topParams[in] Parsed top-level parameter list.
stepsizeParams[in] Step size parameters as described above

References Teuchos::RCP< T >::get(), and Teuchos::rcp().


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