Class container for the 2-stage strong-stability preserving Runge-Kutta (or Heun) order 2 method. More...

#include <SSPRK22.hxx>

Inherits Sandals::RungeKutta< 2, N, 0 >.

Public Types
using	System = typename Implicit<N, M>::Pointer

Public Types inherited from Sandals::RungeKutta< 2, N, 0 >
using	System

using	Type

using	Time

Public Member Functions
	SSPRK22 ()

	SSPRK22 (System t_system)

Public Member Functions inherited from Sandals::RungeKutta< 2, N, 0 >
	RungeKutta (const RungeKutta &)=delete

	RungeKutta (Tableau< S > const &t_tableau)

	RungeKutta (Tableau< S > const &t_tableau, System t_system)

RungeKutta &	operator= (RungeKutta const &)=delete

Type	type () const

bool	is_erk () const

bool	is_irk () const

bool	is_dirk () const

Tableau< S > &	tableau ()

Tableau< S > const &	tableau () const

Integer	stages () const

std::string	name () const

Integer	order () const

bool	is_embedded () const

MatrixS	A () const

VectorS	b () const

VectorS	b_embedded () const

VectorS	c () const

System	system ()

void	system (System t_system)

bool	has_system ()

Real	absolute_tolerance ()

void	absolute_tolerance (Real t_absolute_tolerance)

Real	relative_tolerance ()

void	relative_tolerance (Real t_relative_tolerance)

Real &	safety_factor ()

void	safety_factor (Real t_safety_factor)

Real &	min_safety_factor ()

void	min_safety_factor (Real t_min_safety_factor)

Real &	max_safety_factor ()

void	max_safety_factor (Real t_max_safety_factor)

Real &	min_step ()

void	min_step (Real t_min_step)

Integer &	max_substeps ()

void	max_substeps (Integer t_max_substeps)

bool	adaptive_mode ()

void	adaptive (bool t_adaptive)

void	enable_adaptive_mode ()

void	disable_adaptive_mode ()

bool	verbose_mode ()

void	verbose_mode (bool t_verbose)

void	enable_verbose_mode ()

void	disable_verbose_mode ()

bool	reverse_mode ()

void	reverse (bool t_reverse)

void	enable_reverse_mode ()

void	disable_reverse_mode ()

Real	projection_tolerance ()

void	projection_tolerance (Real t_projection_tolerance)

Integer &	max_projection_iterations ()

void	max_projection_iterations (Integer t_max_projection_iterations)

bool	projection ()

void	projection (bool t_projection)

void	enable_projection ()

void	disable_projection ()

Real	estimate_step (VectorN const &x, VectorN const &x_e, Real h_k) const

std::string	info () const

void	info (std::ostream &os)

bool	erk_explicit_step (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new) const

void	erk_implicit_function (Integer s, VectorN const &x, Real t, Real h, MatrixK const &K, VectorN &fun) const

void	erk_implicit_jacobian (Integer s, VectorN const &x, Real t, Real h, MatrixK const &K, MatrixN &jac) const

bool	erk_implicit_step (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new)

void	irk_function (VectorN const &x, Real t, Real h, VectorK const &K, VectorK &fun) const

void	irk_jacobian (VectorN const &x, Real t, Real h, VectorK const &K, MatrixJ &jac) const

bool	irk_step (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new)

void	dirk_function (Integer n, VectorN const &x, Real t, Real h, MatrixK const &K, VectorN &fun) const

void	dirk_jacobian (Integer n, VectorN const &x, Real t, Real h, MatrixK const &K, MatrixN &jac) const

bool	dirk_step (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new)

bool	step (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new)

bool	advance (VectorN const &x_old, Real t_old, Real h_old, VectorN &x_new, Real &h_new)

bool	solve (VectorX const &t_mesh, VectorN const &ics, Solution< N, M > &sol)

bool	adaptive_solve (VectorX const &t_mesh, VectorN const &ics, Solution< N, M > &sol)

bool	project (VectorN const &x, Real t, VectorN &x_projected)

bool	project_ics (VectorN const &x, Real t, std::vector< Integer > const &projected_equations, std::vector< Integer > const &projected_invariants, VectorN &x_projected) const

Real	estimate_order (std::vector< VectorX > const &t_mesh, VectorN const &ics, std::function< MatrixX(VectorX)> &sol)

Detailed Description

template<Integer N, Integer M = 0>
class Sandals::SSPRK22< N, M >

Class container for the 2-stage strong-stability preserving Runge-Kutta (or Heun) order 2 method.

Template Parameters

N	The dimension of the ODE/DAE system.
M	The dimension of the invariants manifold.

Member Typedef Documentation

◆ System

template<Integer N, Integer M = 0>

using Sandals::SSPRK22< N, M >::System = typename Implicit<N, M>::Pointer

System type.

Constructor & Destructor Documentation

◆ SSPRK22() [1/2]

template<Integer N, Integer M = 0>

Sandals::SSPRK22< N, M >::SSPRK22 ( )

inline

Class constructor for a 2-stage strong-stability preserving Runge-Kutta (or Heun) order 2 solver given a Tableau reference.

◆ SSPRK22() [2/2]

template<Integer N, Integer M = 0>

Sandals::SSPRK22< N, M >::SSPRK22 ( System t_system )

inline

Class constructor for a 2-stage strong-stability preserving Runge-Kutta (or Heun) order 2 solver given a Tableau reference.

Parameters

[in] t_system The system reference.

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

include/Sandals/Tableau/SSPRK22.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ System

Constructor & Destructor Documentation

◆ SSPRK22() [1/2]

◆ SSPRK22() [2/2]