Reference documentation for deal.II version 8.4.1
Public Member Functions | Protected Attributes | List of all members
TimeStepping::RungeKutta< VectorType > Class Template Referenceabstract

#include <deal.II/base/time_stepping.h>

Inheritance diagram for TimeStepping::RungeKutta< VectorType >:
[legend]

Public Member Functions

virtual ~RungeKutta ()
 
virtual void initialize (runge_kutta_method method)=0
 
double evolve_one_time_step (std::vector< std_cxx11::function< VectorType(const double, const VectorType &)> > &F, std::vector< std_cxx11::function< VectorType(const double, const double, const VectorType &)> > &J_inverse, double t, double delta_t, VectorType &y)
 
virtual double evolve_one_time_step (std_cxx11::function< VectorType(const double, const VectorType &)> f, std_cxx11::function< VectorType(const double, const double, const VectorType &)> id_minus_tau_J_inverse, double t, double delta_t, VectorType &y)=0
 
- Public Member Functions inherited from TimeStepping::TimeStepping< VectorType >
virtual ~TimeStepping ()
 
virtual const Statusget_status () const =0
 

Protected Attributes

unsigned int n_stages
 
std::vector< double > b
 
std::vector< double > c
 
std::vector< std::vector< double > > a
 

Detailed Description

template<typename VectorType>
class TimeStepping::RungeKutta< VectorType >

Base class for the Runge-Kutta method

Author
Damien Lebrun-Grandie, Bruno Turcksin
Date
2014

Definition at line 123 of file time_stepping.h.

Constructor & Destructor Documentation

template<typename VectorType >
virtual TimeStepping::RungeKutta< VectorType >::~RungeKutta ( )
inlinevirtual

Virtual destructor.

Definition at line 129 of file time_stepping.h.

Member Function Documentation

template<typename VectorType >
virtual void TimeStepping::RungeKutta< VectorType >::initialize ( runge_kutta_method  method)
pure virtual
template<typename VectorType >
double TimeStepping::RungeKutta< VectorType >::evolve_one_time_step ( std::vector< std_cxx11::function< VectorType(const double, const VectorType &)> > &  F,
std::vector< std_cxx11::function< VectorType(const double, const double, const VectorType &)> > &  J_inverse,
double  t,
double  delta_t,
VectorType &  y 
)
virtual

This function is used to advance from time t to t+ delta_t. F is a vector of functions \( f(t,y) \) that should be integrated, the input parameters are the time t and the vector y and the output is value of f at this point. J_inverse is a vector functions that compute the inverse of the Jacobians associated to the implicit problems. The input parameters are the time, \( \tau \), and a vector. The output is the value of function at this point. This function returns the time at the end of the time step. When using Runge-Kutta methods, F and @ J_inverse can only contain one element.

Implements TimeStepping::TimeStepping< VectorType >.

template<typename VectorType >
virtual double TimeStepping::RungeKutta< VectorType >::evolve_one_time_step ( std_cxx11::function< VectorType(const double, const VectorType &)>  f,
std_cxx11::function< VectorType(const double, const double, const VectorType &)>  id_minus_tau_J_inverse,
double  t,
double  delta_t,
VectorType &  y 
)
pure virtual

Purely virtual function. This function is used to advance from time t to t+ delta_t. f is the function \( f(t,y) \) that should be integrated, the input parameters are the time t and the vector y and the output is value of f at this point. id_minus_tau_J_inverse is a function that computes \( inv(I-\tau J)\) where \( I \) is the identity matrix, \( \tau \) is given, and \( J \) is the Jacobian \( \frac{\partial J}{\partial y} \). The input parameters are the time, \( \tau \), and a vector. The output is the value of function at this point. evolve_one_time_step returns the time at the end of the time step.

Implemented in TimeStepping::EmbeddedExplicitRungeKutta< VectorType >, TimeStepping::ImplicitRungeKutta< VectorType >, and TimeStepping::ExplicitRungeKutta< VectorType >.

Member Data Documentation

template<typename VectorType >
unsigned int TimeStepping::RungeKutta< VectorType >::n_stages
protected

Number of stages of the Runge-Kutta method.

Definition at line 175 of file time_stepping.h.

template<typename VectorType >
std::vector<double> TimeStepping::RungeKutta< VectorType >::b
protected

Butcher tableau coefficients.

Definition at line 180 of file time_stepping.h.

template<typename VectorType >
std::vector<double> TimeStepping::RungeKutta< VectorType >::c
protected

Butcher tableau coefficients.

Definition at line 185 of file time_stepping.h.

template<typename VectorType >
std::vector<std::vector<double> > TimeStepping::RungeKutta< VectorType >::a
protected

Butcher tableau coefficients.

Definition at line 190 of file time_stepping.h.


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