Rythmos - Transient Integration for Differential Equations Version of the Day
Public Member Functions | Related Functions
Rythmos::IntegratorBuilder< Scalar > Class Template Reference

Concrete integrator builder class. More...

#include <Rythmos_IntegratorBuilder_decl.hpp>

List of all members.

Public Member Functions

 IntegratorBuilder ()
 
virtual ~IntegratorBuilder ()
 
void setIntegratorFactory (const RCP< const AbstractFactory< IntegratorBase< Scalar > > > &integratorFactory, const std::string &integratorFactoryName)
 Set a new Integrator factory object.
void setIntegrationControlFactory (const RCP< const AbstractFactory< IntegrationControlStrategyBase< Scalar > > > &integrationControlFactory, const std::string &integrationControlName)
 Set a new Integration Control Strategy factory object.
void setStepperBuilder (const RCP< StepperBuilder< Scalar > > &stepperBuilder)
 Set the Stepper Builder object.
RCP< StepperBuilder< Scalar > > getStepperBuilder ()
 Get the Stepper Builder object.
void setRKButcherTableauBuilder (const RCP< RKButcherTableauBuilder< Scalar > > &rkbtBuilder)
 Set the RK Butcher Tableau Builder object.
void setStepControlFactory (const RCP< const AbstractFactory< StepControlStrategyBase< Scalar > > > &stepControlStrategyFactory, const std::string &stepControlName)
 Set a new Step Control Strategy factory object.
void setInterpolationBufferFactory (const RCP< const AbstractFactory< InterpolationBufferBase< Scalar > > > &interpolationBufferFactory, const std::string &interpolationBufferName)
 Set an InterpolationBuffer factory object.
void setInterpolationBufferAppenderFactory (const RCP< const AbstractFactory< InterpolationBufferAppenderBase< Scalar > > > &interpolationBufferAppenderFactory, const std::string &interpolationBufferAppenderName)
 Set an InterpolationBufferAppender factory object.
void setErrWtVecCalcFactory (const RCP< const AbstractFactory< ErrWtVecCalcBase< Scalar > > > &errWtVecCalcFactory, const std::string &errWtVecCalcFactoryName)
 Set an ErrWtVecCalc factory object.
void setInterpolatorFactory (const RCP< const AbstractFactory< InterpolatorBase< Scalar > > > &interpolatorFactory, const std::string &interpolatorFactoryName)
 Set an Interpolator factory object.
void setWFactoryObject (const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &wFactoryObject)
 Set a W factory object.
RCP< IntegratorBase< Scalar > > create (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition, const RCP< Thyra::NonlinearSolverBase< Scalar > > &nlSolver) const
 Create an fully formed integrator ready to go.

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< IntegratorBuilder< Scalar > > integratorBuilder ()
 Nonmember constructor to uninitialized.
template<class Scalar >
RCP< IntegratorBuilder< Scalar > > integratorBuilder (const RCP< ParameterList > &paramList)
 Nonmember constructor given parameter list.
template<class Scalar >
RCP< IntegratorBase< Scalar > > createForwardSensitivityIntegrator (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int &p_index, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &model_ic, const RCP< Thyra::NonlinearSolverBase< Scalar > > &nlSolver, const RCP< ParameterList > &integratorBuilderPL)
 Creates a Forward Sensitivity Integrator Initial conditions for the sensitivities are all zero.

Overridden from Teuchos::ParameterListAcceptor

void setParameterList (const RCP< Teuchos::ParameterList > &paramList)
 
RCP< const Teuchos::ParameterList > getValidParameters () const
 
RCP< ParameterList > getNonconstParameterList ()
 
RCP< ParameterList > unsetParameterList ()
 
RCP< const ParameterList > getParameterList () const
 

Detailed Description

template<class Scalar>
class Rythmos::IntegratorBuilder< Scalar >

Concrete integrator builder class.

ToDo: Finish documentation!

Definition at line 63 of file Rythmos_IntegratorBuilder_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Rythmos::IntegratorBuilder< Scalar >::IntegratorBuilder ( )

Definition at line 311 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
Rythmos::IntegratorBuilder< Scalar >::~IntegratorBuilder ( ) [virtual]

Definition at line 318 of file Rythmos_IntegratorBuilder_def.hpp.


Member Function Documentation

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setIntegratorFactory ( const RCP< const AbstractFactory< IntegratorBase< Scalar > > > &  integratorFactory,
const std::string &  integratorFactoryName 
)

Set a new Integrator factory object.

Definition at line 324 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setIntegrationControlFactory ( const RCP< const AbstractFactory< IntegrationControlStrategyBase< Scalar > > > &  integrationControlFactory,
const std::string &  integrationControlName 
)

Set a new Integration Control Strategy factory object.

Definition at line 335 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setStepperBuilder ( const RCP< StepperBuilder< Scalar > > &  stepperBuilder)

Set the Stepper Builder object.

Definition at line 347 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< StepperBuilder< Scalar > > Rythmos::IntegratorBuilder< Scalar >::getStepperBuilder ( )

Get the Stepper Builder object.

Definition at line 358 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setRKButcherTableauBuilder ( const RCP< RKButcherTableauBuilder< Scalar > > &  rkbtBuilder)

Set the RK Butcher Tableau Builder object.

Definition at line 365 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setStepControlFactory ( const RCP< const AbstractFactory< StepControlStrategyBase< Scalar > > > &  stepControlStrategyFactory,
const std::string &  stepControlName 
)

Set a new Step Control Strategy factory object.

Definition at line 376 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setInterpolationBufferFactory ( const RCP< const AbstractFactory< InterpolationBufferBase< Scalar > > > &  interpolationBufferFactory,
const std::string &  interpolationBufferName 
)

Set an InterpolationBuffer factory object.

Definition at line 389 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setInterpolationBufferAppenderFactory ( const RCP< const AbstractFactory< InterpolationBufferAppenderBase< Scalar > > > &  interpolationBufferAppenderFactory,
const std::string &  interpolationBufferAppenderName 
)

Set an InterpolationBufferAppender factory object.

Definition at line 400 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setErrWtVecCalcFactory ( const RCP< const AbstractFactory< ErrWtVecCalcBase< Scalar > > > &  errWtVecCalcFactory,
const std::string &  errWtVecCalcFactoryName 
)

Set an ErrWtVecCalc factory object.

Definition at line 412 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setInterpolatorFactory ( const RCP< const AbstractFactory< InterpolatorBase< Scalar > > > &  interpolatorFactory,
const std::string &  interpolatorFactoryName 
)

Set an Interpolator factory object.

Definition at line 425 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setWFactoryObject ( const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &  wFactoryObject)

Set a W factory object.

Definition at line 438 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< IntegratorBase< Scalar > > Rythmos::IntegratorBuilder< Scalar >::create ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  initialCondition,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  nlSolver 
) const

Create an fully formed integrator ready to go.

Parameters:
model[in] The model evaluator object. What initialization state does this object need to be in before calling this function?
initialCondition[in] Initial condition for the integration. If the real initial condition is not known, then a zero IC can be passed in here and then be rest with returnVal->setInitialCondition(...) later.
nlSolver[in] The nonlinear solver that will be set on an implicit stepper object. If an explicit stepper will be created, then this can be left null.

Definition at line 713 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
void Rythmos::IntegratorBuilder< Scalar >::setParameterList ( const RCP< Teuchos::ParameterList > &  paramList)

Definition at line 448 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< const Teuchos::ParameterList > Rythmos::IntegratorBuilder< Scalar >::getValidParameters ( ) const

Definition at line 460 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< ParameterList > Rythmos::IntegratorBuilder< Scalar >::getNonconstParameterList ( )

Definition at line 678 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< ParameterList > Rythmos::IntegratorBuilder< Scalar >::unsetParameterList ( )

Definition at line 685 of file Rythmos_IntegratorBuilder_def.hpp.

template<class Scalar >
RCP< const ParameterList > Rythmos::IntegratorBuilder< Scalar >::getParameterList ( ) const

Definition at line 694 of file Rythmos_IntegratorBuilder_def.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< IntegratorBuilder< Scalar > > integratorBuilder ( ) [related]

Nonmember constructor to uninitialized.

template<class Scalar >
RCP< IntegratorBuilder< Scalar > > integratorBuilder ( const RCP< ParameterList > &  paramList) [related]

Nonmember constructor given parameter list.

template<class Scalar >
RCP< IntegratorBase< Scalar > > createForwardSensitivityIntegrator ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
const int &  p_index,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  model_ic,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  nlSolver,
const RCP< ParameterList > &  integratorBuilderPL 
) [related]

Creates a Forward Sensitivity Integrator Initial conditions for the sensitivities are all zero.


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