TimeIntegrator Class Reference

#include <time_integrator.h>

Inheritance diagram for TimeIntegrator:

Public Member Functions
virtual	~TimeIntegrator ()=default
TimeIntegratorType	get_type () const
uint8_t	get_n_solution_vectors () const
uint8_t	get_n_rhs_vectors () const
virtual void	take_step (const rtype t, const rtype dt, std::vector< State > &solution_vec, std::vector< State > &rhs_vec, const RHSFunction &calc_rhs, const rtype *dt_device=nullptr)=0
	Advance solution_vec[0] from time t by dt.

Protected Attributes
TimeIntegratorType	type
uint8_t	n_solution_vectors
uint8_t	n_rhs_vectors

Constructor & Destructor Documentation

~TimeIntegrator()

virtual TimeIntegrator::~TimeIntegrator ( )

virtualdefault

Member Function Documentation

get_n_rhs_vectors()

uint8_t TimeIntegrator::get_n_rhs_vectors ( ) const

inline

get_n_solution_vectors()

uint8_t TimeIntegrator::get_n_solution_vectors ( ) const

inline

get_type()

TimeIntegratorType TimeIntegrator::get_type ( ) const

inline

take_step()

virtual void TimeIntegrator::take_step ( const rtype  t, const rtype  dt, std::vector< State > &  solution_vec, std::vector< State > &  rhs_vec, const RHSFunction &  calc_rhs, const rtype *  dt_device = nullptr  )

pure virtual

Advance solution_vec[0] from time t by dt.

Parameters

t	Time at the start of the step.
dt	Time step.
solution_vec	Solution (index 0) and scratch states.
rhs_vec	Scratch RHS states.
calc_rhs	RHS evaluator, dU/dt = calc_rhs(U, t).
dt_device	Device array of dt's multiples (see dt_scales), which the updates read instead of dt when given.

Implemented in FE, RK4, and SSPRK3.

Member Data Documentation

n_rhs_vectors

uint8_t TimeIntegrator::n_rhs_vectors

protected

n_solution_vectors

uint8_t TimeIntegrator::n_solution_vectors

protected

type

TimeIntegratorType TimeIntegrator::type

protected

---

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

• /home/runner/work/mallard/mallard/mallard/src/numerics/time_integrator.h