Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
Tempus::RKButcherTableauBuilder< Scalar > Class Template Reference

Runge-Kutta Builder class. This factory creates RKButcherTableau objects given the description string from the RKButcherTableau object. More...

#include <Tempus_RKButcherTableauBuilder_decl.hpp>

Inheritance diagram for Tempus::RKButcherTableauBuilder< Scalar >:

Public Member Functions

 RKButcherTableauBuilder ()
 
virtual ~RKButcherTableauBuilder ()
 
void setRKButcherTableauFactory (const Teuchos::RCP< const Teuchos::AbstractFactory< RKButcherTableau< Scalar > > > &rkbtFactory, const std::string &rkbtFactoryName)
 
Teuchos::RCP< RKButcherTableau< Scalar > > create (const std::string &rkbt_name="") const
 

Overridden from Teuchos::ParameterListAcceptor

Teuchos::ObjectBuilder< RKButcherTableau< Scalar > > builder_
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &paramList)
 
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList ()
 
Teuchos::RCP< const Teuchos::ParameterList > getParameterList () const
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
void initializeDefaults_ ()
 

Detailed Description

template<class Scalar>
class Tempus::RKButcherTableauBuilder< Scalar >

Runge-Kutta Builder class. This factory creates RKButcherTableau objects given the description string from the RKButcherTableau object.

This was taken and modified from Rythmos' RKButcherTableauBuilder class.

Definition at line 26 of file Tempus_RKButcherTableauBuilder_decl.hpp.

Constructor & Destructor Documentation

◆ RKButcherTableauBuilder()

template<class Scalar >
Tempus::RKButcherTableauBuilder< Scalar >::RKButcherTableauBuilder ( )

Definition at line 38 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ ~RKButcherTableauBuilder()

template<class Scalar >
virtual Tempus::RKButcherTableauBuilder< Scalar >::~RKButcherTableauBuilder ( )
inlinevirtual

Definition at line 31 of file Tempus_RKButcherTableauBuilder_decl.hpp.

Member Function Documentation

◆ create()

template<class Scalar >
Teuchos::RCP< RKButcherTableau< Scalar > > Tempus::RKButcherTableauBuilder< Scalar >::create ( const std::string &  rkbt_name = "") const

Definition at line 94 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ getNonconstParameterList()

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Tempus::RKButcherTableauBuilder< Scalar >::getNonconstParameterList ( )

Definition at line 63 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ getParameterList()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus::RKButcherTableauBuilder< Scalar >::getParameterList ( ) const

Definition at line 79 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus::RKButcherTableauBuilder< Scalar >::getValidParameters ( ) const

Definition at line 87 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ initializeDefaults_()

template<class Scalar >
void Tempus::RKButcherTableauBuilder< Scalar >::initializeDefaults_ ( )
private

Definition at line 102 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ setParameterList()

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

Definition at line 54 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ setRKButcherTableauFactory()

template<class Scalar >
void Tempus::RKButcherTableauBuilder< Scalar >::setRKButcherTableauFactory ( const Teuchos::RCP< const Teuchos::AbstractFactory< RKButcherTableau< Scalar > > > &  rkbtFactory,
const std::string &  rkbtFactoryName 
)

Definition at line 44 of file Tempus_RKButcherTableauBuilder_impl.hpp.

◆ unsetParameterList()

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Tempus::RKButcherTableauBuilder< Scalar >::unsetParameterList ( )

Definition at line 71 of file Tempus_RKButcherTableauBuilder_impl.hpp.

Member Data Documentation

◆ builder_

template<class Scalar >
Teuchos::ObjectBuilder<RKButcherTableau<Scalar> > Tempus::RKButcherTableauBuilder< Scalar >::builder_
private

Definition at line 52 of file Tempus_RKButcherTableauBuilder_decl.hpp.

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