Reference documentation for deal.II version Git 8236ec9b21 2019-11-20 14:24:58 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Member Functions | List of all members
TimeStepping::TimeStepping< VectorType > Class Template Referenceabstract

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

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

Classes

struct  Status
 

Public Member Functions

virtual ~TimeStepping ()=default
 
virtual 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)=0
 
virtual const Statusget_status () const =0
 

Detailed Description

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

Abstract class for time stepping methods. These methods assume that the equation has the form: \( \frac{\partial y}{\partial t} = f(t,y) \).

Definition at line 96 of file time_stepping.h.

Constructor & Destructor Documentation

◆ ~TimeStepping()

template<typename VectorType >
virtual TimeStepping::TimeStepping< VectorType >::~TimeStepping ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ evolve_one_time_step()

template<typename VectorType >
virtual double TimeStepping::TimeStepping< 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 
)
pure virtual

Purely virtual function. 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.

Implemented in TimeStepping::RungeKutta< VectorType >.

◆ get_status()

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

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