Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Tempus::RKButcherTableau< Scalar > Class Template Reference

Runge-Kutta methods. More...

#include <Tempus_RKButcherTableau.hpp>

Inheritance diagram for Tempus::RKButcherTableau< Scalar >:

Public Member Functions

 RKButcherTableau (std::string stepperType, const Teuchos::SerialDenseMatrix< int, Scalar > &A, const Teuchos::SerialDenseVector< int, Scalar > &b, const Teuchos::SerialDenseVector< int, Scalar > &c, const int order, const int orderMin, const int orderMax, const Teuchos::SerialDenseVector< int, Scalar > &bstar=Teuchos::SerialDenseVector< int, Scalar >(), bool checkC=true)
 
virtual std::size_t numStages () const
 Return the number of stages. More...
 
virtual const
Teuchos::SerialDenseMatrix
< int, Scalar > & 		A () const
 Return the matrix coefficients. More...
 
virtual const
Teuchos::SerialDenseVector
< int, Scalar > & 		b () const
 Return the vector of quadrature weights. More...
 
virtual const
Teuchos::SerialDenseVector
< int, Scalar > & 		bstar () const
 Return the vector of quadrature weights for embedded methods. More...
 
virtual const
Teuchos::SerialDenseVector
< int, Scalar > & 		c () const
 Return the vector of stage positions. More...
 
virtual int order () const
 Return the order. More...
 
virtual int orderMin () const
 Return the minimum order. More...
 
virtual int orderMax () const
 Return the maximum order. More...
 
virtual bool isImplicit () const
 Return true if the RK method is implicit. More...
 
virtual bool isDIRK () const
 Return true if the RK method is Diagonally Implicit. More...
 
virtual bool isEmbedded () const
 Return true if the RK method has embedded capabilities. More...
 
bool operator== (const RKButcherTableau &t) const
 
bool operator!= (const RKButcherTableau &t) const
 
virtual std::string description () const
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Protected Member Functions

void set_isImplicit ()
 
void set_isDIRK ()
 DIRK is defined as if a_ij = 0 for j>i and a_ii != 0 for at least one i. More...
 

Protected Attributes

std::string description_
 
Teuchos::SerialDenseMatrix
< int, Scalar > 		A_
 
Teuchos::SerialDenseVector
< int, Scalar > 		b_
 
Teuchos::SerialDenseVector
< int, Scalar > 		c_
 
int order_
 
int orderMin_
 
int orderMax_
 
bool isImplicit_
 
bool isDIRK_
 
bool isEmbedded_
 
Teuchos::SerialDenseVector
< int, Scalar > 		bstar_
 

Private Member Functions

 RKButcherTableau ()
 

Detailed Description

template<class Scalar>
class Tempus::RKButcherTableau< Scalar >

Runge-Kutta methods.

This base class specifies the Butcher tableau which defines the Runge-Kutta (RK) method. Both explicit and implicit RK methods can be specified here, and of arbitrary number of stages and orders. Embedded methods are also supported.

Since this is a generic RK class, no low-storage methods are incorporated here, however any RK method with a Butcher tableau can be created with the base class.

There are over 40 derived RK methods that have been implemented, ranging from first order and eight order, and from single stage to 5 stages.

This class was taken and modified from Rythmos' RKButcherTableau class.

Definition at line 50 of file Tempus_RKButcherTableau.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::RKButcherTableau< Scalar >::RKButcherTableau ( std::string  stepperType,
const Teuchos::SerialDenseMatrix< int, Scalar > &  A,
const Teuchos::SerialDenseVector< int, Scalar > &  b,
const Teuchos::SerialDenseVector< int, Scalar > &  c,
const int  order,
const int  orderMin,
const int  orderMax,
const Teuchos::SerialDenseVector< int, Scalar > &  bstar = Teuchos::SerialDenseVector<int,Scalar>(),
bool  checkC = true 
)
inline

Definition at line 56 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
Tempus::RKButcherTableau< Scalar >::RKButcherTableau ( )
private

Member Function Documentation

template<class Scalar >
virtual const Teuchos::SerialDenseMatrix<int,Scalar>& Tempus::RKButcherTableau< Scalar >::A ( ) const
inlinevirtual

Return the matrix coefficients.

Definition at line 126 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual const Teuchos::SerialDenseVector<int,Scalar>& Tempus::RKButcherTableau< Scalar >::b ( ) const
inlinevirtual

Return the vector of quadrature weights.

Definition at line 129 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual const Teuchos::SerialDenseVector<int,Scalar>& Tempus::RKButcherTableau< Scalar >::bstar ( ) const
inlinevirtual

Return the vector of quadrature weights for embedded methods.

Definition at line 132 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual const Teuchos::SerialDenseVector<int,Scalar>& Tempus::RKButcherTableau< Scalar >::c ( ) const
inlinevirtual

Return the vector of stage positions.

Definition at line 135 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual void Tempus::RKButcherTableau< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
inlinevirtual

Definition at line 154 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual std::string Tempus::RKButcherTableau< Scalar >::description ( ) const
inlinevirtual

Definition at line 152 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual bool Tempus::RKButcherTableau< Scalar >::isDIRK ( ) const
inlinevirtual

Return true if the RK method is Diagonally Implicit.

Definition at line 146 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual bool Tempus::RKButcherTableau< Scalar >::isEmbedded ( ) const
inlinevirtual

Return true if the RK method has embedded capabilities.

Definition at line 148 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual bool Tempus::RKButcherTableau< Scalar >::isImplicit ( ) const
inlinevirtual

Return true if the RK method is implicit.

Definition at line 144 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual std::size_t Tempus::RKButcherTableau< Scalar >::numStages ( ) const
inlinevirtual

Return the number of stages.

Definition at line 124 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
bool Tempus::RKButcherTableau< Scalar >::operator!= ( const RKButcherTableau< Scalar > &  t) const
inline

Definition at line 203 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
bool Tempus::RKButcherTableau< Scalar >::operator== ( const RKButcherTableau< Scalar > &  t) const
inline

Definition at line 174 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual int Tempus::RKButcherTableau< Scalar >::order ( ) const
inlinevirtual

Return the order.

Definition at line 138 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual int Tempus::RKButcherTableau< Scalar >::orderMax ( ) const
inlinevirtual

Return the maximum order.

Definition at line 142 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
virtual int Tempus::RKButcherTableau< Scalar >::orderMin ( ) const
inlinevirtual

Return the minimum order.

Definition at line 140 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
void Tempus::RKButcherTableau< Scalar >::set_isDIRK ( )
inlineprotected

DIRK is defined as if a_ij = 0 for j>i and a_ii != 0 for at least one i.

Definition at line 221 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
void Tempus::RKButcherTableau< Scalar >::set_isImplicit ( )
inlineprotected

Definition at line 213 of file Tempus_RKButcherTableau.hpp.

Member Data Documentation

template<class Scalar >
Teuchos::SerialDenseMatrix<int,Scalar> Tempus::RKButcherTableau< Scalar >::A_
protected

Definition at line 234 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
Teuchos::SerialDenseVector<int,Scalar> Tempus::RKButcherTableau< Scalar >::b_
protected

Definition at line 235 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
Teuchos::SerialDenseVector<int,Scalar> Tempus::RKButcherTableau< Scalar >::bstar_
protected

Definition at line 243 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
Teuchos::SerialDenseVector<int,Scalar> Tempus::RKButcherTableau< Scalar >::c_
protected

Definition at line 236 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
std::string Tempus::RKButcherTableau< Scalar >::description_
protected

Definition at line 232 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
bool Tempus::RKButcherTableau< Scalar >::isDIRK_
protected

Definition at line 241 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
bool Tempus::RKButcherTableau< Scalar >::isEmbedded_
protected

Definition at line 242 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
bool Tempus::RKButcherTableau< Scalar >::isImplicit_
protected

Definition at line 240 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
int Tempus::RKButcherTableau< Scalar >::order_
protected

Definition at line 237 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
int Tempus::RKButcherTableau< Scalar >::orderMax_
protected

Definition at line 239 of file Tempus_RKButcherTableau.hpp.

template<class Scalar >
int Tempus::RKButcherTableau< Scalar >::orderMin_
protected

Definition at line 238 of file Tempus_RKButcherTableau.hpp.

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