DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec > Class Template Reference

A class to perform time stepping using adaptive Boost Runge-Kutta methods. This stepper uses adaptive time steps and is fully explicit. More...

#include <boost_rk.hh>

Inheritance diagram for DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >:

Public Types
using	NumberType = typename Base::NumberType
using	InverseSparseMatrixType = typename get_type::InverseSparseMatrixType<SparseMatrixType>
using	BlockVectorType = typename Base::BlockVectorType
using	error_stepper_type = typename stepperChoice<prec>::value

Public Member Functions
	TimeStepperBoostRK_impl (const ConfigTree &config, AbstractAssembler< VectorType, SparseMatrixType, dim > &assembler, OutputSession_impl< dim, VectorType > &data_out)
	TimeStepperBoostRK_impl (const ConfigTree &config, AbstractAssembler< VectorType, SparseMatrixType, dim > &assembler, OutputSession_impl< dim, VectorType > &data_out, AbstractAdaptor< VectorType > &adaptor)
virtual void	run (AbstractFlowingVariables< NumberType, VectorType > &initial_condition, const double t_start, const double t_stop) override
	Run the time stepping algorithm.
Public Member Functions inherited from DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >
	AbstractTimestepper (const ConfigTree &config, AbstractAssembler< VectorType, SparseMatrixType, dim > &assembler, OutputSession_impl< dim, VectorType > &data_out, const bool implicit_stepper, const bool explicit_stepper)
	Construct a new Abstract Timestepper object.
	AbstractTimestepper (const ConfigTree &config, AbstractAssembler< VectorType, SparseMatrixType, dim > &assembler, OutputSession_impl< dim, VectorType > &data_out, AbstractAdaptor< VectorType > &adaptor, const bool implicit_stepper, const bool explicit_stepper)

Private Types
using	Base = AbstractTimestepper<VectorType, SparseMatrixType, dim>

Private Member Functions
void	run (VectorType &initial_data, const double t_start, const double t_stop)
void	run (BlockVectorType &initial_data, const double t_start, const double t_stop)
void	run_vars (VectorType &initial_data, const double t_start, const double t_stop)

Additional Inherited Members
Protected Types inherited from DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >
using	VectorType
using	NumberType
using	SparseMatrixType
using	BlockVectorType
Protected Member Functions inherited from DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >
void	drain_output ()
void	finalize_output_after_failure (EmitFinalFrame &&emit_final_frame)
	Best-effort output cleanup while a timestepping failure is being reported.
bool	is_implicit () const
bool	is_explicit () const
Protected Attributes inherited from DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >
const ConfigTree	config
NoAdaptivity< VectorType >	adaptor_default
AbstractAssembler< VectorType, SparseMatrixType, dim > &	assembler
OutputSession_impl< dim, VectorType > &	data_out
AbstractAdaptor< VectorType > &	adaptor
ReportPort	log
const bool	m_is_implicit
const bool	m_is_explicit
double	output_dt
struct DiFfRG::AbstractTimestepper::ImplicitParameters	impl
struct DiFfRG::AbstractTimestepper::ExplicitParameters	expl
std::size_t	next_jacobian_build_id
TimestepperJacobianDiagnosticsState	jacobian_diagnostics_state
Static Protected Attributes inherited from DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >
static constexpr uint	dim

Detailed Description

template<typename VectorType, typename SparseMatrixType, uint dim, int prec>
class DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >

A class to perform time stepping using adaptive Boost Runge-Kutta methods. This stepper uses adaptive time steps and is fully explicit.

Template Parameters

VectorType	Type of the vector
dim	Dimension of the problem
prec	Algorithm choice: 0 for Cash-Karp54 (5th order), 1 for Fehlberg78 (8th order)

Member Typedef Documentation

Base

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

using DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::Base = AbstractTimestepper<VectorType, SparseMatrixType, dim>

private

BlockVectorType

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

using DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::BlockVectorType = typename Base::BlockVectorType

error_stepper_type

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

using DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::error_stepper_type = typename stepperChoice<prec>::value

InverseSparseMatrixType

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

using DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::InverseSparseMatrixType = typename get_type::InverseSparseMatrixType<SparseMatrixType>

NumberType

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

using DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::NumberType = typename Base::NumberType

Constructor & Destructor Documentation

TimeStepperBoostRK_impl() [1/2]

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::TimeStepperBoostRK_impl ( const ConfigTree & config, AbstractAssembler< VectorType, SparseMatrixType, dim > & assembler, OutputSession_impl< dim, VectorType > & data_out )

inline

Forwards to the base with this stepper's kind. Not using Base::Base;: the base needs to know which /timestepping/ section to read, and it cannot ask a virtual function for that from inside its own constructor.

TimeStepperBoostRK_impl() [2/2]

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::TimeStepperBoostRK_impl ( const ConfigTree & config, AbstractAssembler< VectorType, SparseMatrixType, dim > & assembler, OutputSession_impl< dim, VectorType > & data_out, AbstractAdaptor< VectorType > & adaptor )

inline

Member Function Documentation

run() [1/3]

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

virtual void DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::run ( AbstractFlowingVariables< NumberType, VectorType > & initial_condition, const double t_start, const double t_stop )

overridevirtual

Run the time stepping algorithm.

Implements DiFfRG::AbstractTimestepper< VectorType, SparseMatrixType, dim >.

run() [2/3]

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

void DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::run ( BlockVectorType & initial_data, const double t_start, const double t_stop )

private

run() [3/3]

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

void DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::run ( VectorType & initial_data, const double t_start, const double t_stop )

private

run_vars()

template<typename VectorType , typename SparseMatrixType , uint dim, int prec>

void DiFfRG::TimeStepperBoostRK_impl< VectorType, SparseMatrixType, dim, prec >::run_vars ( VectorType & initial_data, const double t_start, const double t_stop )

private

---

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

• /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/timestepping/boost_rk.hh