LOCA::StepSize::Factory Class Reference

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

#include <LOCA_StepSize_Factory.H>

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.

Private Member Functions

 Factory (const Factory &)
 Private to prohibit copying.
Factoryoperator= (const Factory &)
 Private to prohibit copying.


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.

Definition at line 79 of file LOCA_StepSize_Factory.H.


Constructor & Destructor Documentation

LOCA::StepSize::Factory::Factory ( const Teuchos::RCP< LOCA::GlobalData > &  global_data  ) 

Constructor.

Definition at line 51 of file LOCA_StepSize_Factory.C.

LOCA::StepSize::Factory::~Factory (  )  [virtual]

Destructor.

Definition at line 57 of file LOCA_StepSize_Factory.C.

LOCA::StepSize::Factory::Factory ( const Factory  )  [private]

Private to prohibit copying.


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

Definition at line 62 of file LOCA_StepSize_Factory.C.

References globalData, and strategyName().

Referenced by LOCA::Factory::createStepSizeStrategy().

const string & LOCA::StepSize::Factory::strategyName ( Teuchos::ParameterList &  stepsizeParams  )  const

Return strategy name given by stepsizeParams.

Definition at line 107 of file LOCA_StepSize_Factory.C.

Referenced by create(), and LOCA::Factory::createStepSizeStrategy().

Factory& LOCA::StepSize::Factory::operator= ( const Factory  )  [private]

Private to prohibit copying.


Member Data Documentation

Global data.

Definition at line 113 of file LOCA_StepSize_Factory.H.

Referenced by create().


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

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