TimeStepping::RungeKutta< VectorType > Class Template Reference

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

Inheritance diagram for TimeStepping::RungeKutta< VectorType >:

Public Member Functions
virtual	~RungeKutta () override=default
virtual void	initialize (const runge_kutta_method method)=0
double	evolve_one_time_step (std::vector< std::function< VectorType(const double, const VectorType &)> > &F, std::vector< std::function< VectorType(const double, const double, const VectorType &)> > &J_inverse, double t, double delta_t, VectorType &y) override
virtual double	evolve_one_time_step (const std::function< VectorType(const double, const VectorType &)> &f, const std::function< VectorType(const double, const double, const VectorType &)> &id_minus_tau_J_inverse, double t, double delta_t, VectorType &y)=0
virtual const Status &	get_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

Definition at line 222 of file time_stepping.h.

Constructor & Destructor Documentation

~RungeKutta()

template<typename VectorType >

virtual TimeStepping::RungeKutta< VectorType >::~RungeKutta ( )

overridevirtualdefault

Virtual destructor.

Member Function Documentation

initialize()

template<typename VectorType >

virtual void TimeStepping::RungeKutta< VectorType >::initialize ( const runge_kutta_method  method )

pure virtual

Purely virtual method used to initialize the Runge-Kutta method.

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

evolve_one_time_step() [1/2]

template<typename VectorType >

double TimeStepping::RungeKutta< VectorType >::evolve_one_time_step ( std::vector< std::function< VectorType(const double, const VectorType &)> > &  F, std::vector< std::function< VectorType(const double, const double, const VectorType &)> > &  J_inverse, double  t, double  delta_t, VectorType &  y  )

overridevirtual

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 >.

evolve_one_time_step() [2/2]

template<typename VectorType >

virtual double TimeStepping::RungeKutta< VectorType >::evolve_one_time_step ( const std::function< VectorType(const double, const VectorType &)> &  f, const std::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 f}{\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::ExplicitRungeKutta< VectorType >, TimeStepping::LowStorageRungeKutta< VectorType >, TimeStepping::ImplicitRungeKutta< VectorType >, and TimeStepping::EmbeddedExplicitRungeKutta< VectorType >.

get_status()

template<typename VectorType >

virtual const Status & TimeStepping::TimeStepping< VectorType >::get_status ( ) const

pure virtualinherited

Purely virtual function that return Status.

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

Member Data Documentation

n_stages

template<typename VectorType >

unsigned int TimeStepping::RungeKutta< VectorType >::n_stages

protected

Number of stages of the Runge-Kutta method.

Definition at line 282 of file time_stepping.h.

b

template<typename VectorType >

std::vector<double> TimeStepping::RungeKutta< VectorType >::b

protected

Butcher tableau coefficients.

Definition at line 287 of file time_stepping.h.

c

template<typename VectorType >

std::vector<double> TimeStepping::RungeKutta< VectorType >::c

protected

Butcher tableau coefficients.

Definition at line 292 of file time_stepping.h.

a

template<typename VectorType >

std::vector<std::vector<double> > TimeStepping::RungeKutta< VectorType >::a

protected

Butcher tableau coefficients.

Definition at line 297 of file time_stepping.h.

---

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

• include/deal.II/base/time_stepping.h