num_collect::ode::avf::avf4_formula< Problem > Class Template Reference

Class of 4th order average vector field (AVF) method [21]. More...

#include <num_collect/ode/avf/avf4_formula.h>

Collaboration diagram for num_collect::ode::avf::avf4_formula< Problem >:

Public Types
using	jacobian_type = typename problem_type::jacobian_type
	Type of Jacobian.
using	problem_type = Problem
	Type of problem.
using	scalar_type = typename problem_type::scalar_type
	Type of scalars.
using	variable_type = typename problem_type::variable_type
	Type of variables.

Public Member Functions
	avf4_formula (const problem_type &problem=problem_type())
	Constructor.
auto	problem () -> problem_type &
	Get the problem.
auto	problem () const -> const problem_type &
	Get the problem.
void	step (scalar_type time, scalar_type step_size, const variable_type &current, variable_type &estimate)
	Compute the next variable.
void	tol_residual_norm (scalar_type val)
	Set tolerance of residual norm.

Static Public Attributes
static constexpr auto	log_tag
	Log tag.
static constexpr index_type	order = 4
	Order of this formula.
static constexpr index_type	stages = 1
	Number of stages of this formula.

Private Attributes
impl::avf_integrand< problem_type >	integrand_
	Integrand.
integration::gauss_legendre_integrator< variable_type(scalar_type)>	integrator_ {integrator_degree}
	Integrator.
scalar_type	tol_residual_norm_ {default_tol_residual_norm}
	Tolerance of residual norm.

Static Private Attributes
static constexpr auto	default_tol_residual_norm
	Default tolerance of residual norm.
static constexpr index_type	integrator_degree = 5
	Degree of integrator.

Detailed Description

template<concepts::differentiable_problem Problem>
class num_collect::ode::avf::avf4_formula< Problem >

Class of 4th order average vector field (AVF) method [21].

Template Parameters

Problem

Type of problem.

Definition at line 47 of file avf4_formula.h.

Member Typedef Documentation

jacobian_type

template<concepts::differentiable_problem Problem>

using num_collect::ode::avf::avf4_formula< Problem >::jacobian_type = typename problem_type::jacobian_type

Type of Jacobian.

Definition at line 59 of file avf4_formula.h.

problem_type

template<concepts::differentiable_problem Problem>

using num_collect::ode::avf::avf4_formula< Problem >::problem_type = Problem

Type of problem.

Definition at line 50 of file avf4_formula.h.

scalar_type

template<concepts::differentiable_problem Problem>

using num_collect::ode::avf::avf4_formula< Problem >::scalar_type = typename problem_type::scalar_type

Type of scalars.

Definition at line 56 of file avf4_formula.h.

variable_type

template<concepts::differentiable_problem Problem>

using num_collect::ode::avf::avf4_formula< Problem >::variable_type = typename problem_type::variable_type

Type of variables.

Definition at line 53 of file avf4_formula.h.

Constructor & Destructor Documentation

avf4_formula()

template<concepts::differentiable_problem Problem>

num_collect::ode::avf::avf4_formula< Problem >::avf4_formula ( const problem_type & problem = problem_type() )

inlineexplicit

Constructor.

Parameters

[in]

problem

Problem.

Definition at line 76 of file avf4_formula.h.

Member Function Documentation

problem() [1/2]

template<concepts::differentiable_problem Problem>

auto num_collect::ode::avf::avf4_formula< Problem >::problem ( ) -> problem_type&

inlinenodiscard

Get the problem.

Returns

Problem.

Definition at line 132 of file avf4_formula.h.

problem() [2/2]

template<concepts::differentiable_problem Problem>

auto num_collect::ode::avf::avf4_formula< Problem >::problem ( ) const -> const problem_type&

inlinenodiscard

Get the problem.

Returns

Problem.

Definition at line 141 of file avf4_formula.h.

step()

template<concepts::differentiable_problem Problem>

void num_collect::ode::avf::avf4_formula< Problem >::step ( scalar_type time, scalar_type step_size, const variable_type & current, variable_type & estimate )

inline

Compute the next variable.

Parameters

[in]	time	Current time.
[in]	step_size	Step size.
[in]	current	Current variable.
[out]	estimate	Estimate of the next variable.

Definition at line 87 of file avf4_formula.h.

tol_residual_norm()

template<concepts::differentiable_problem Problem>

void num_collect::ode::avf::avf4_formula< Problem >::tol_residual_norm ( scalar_type val )

inline

Set tolerance of residual norm.

Parameters

[in]

val

Value.

Definition at line 150 of file avf4_formula.h.

Member Data Documentation

default_tol_residual_norm

template<concepts::differentiable_problem Problem>

auto num_collect::ode::avf::avf4_formula< Problem >::default_tol_residual_norm

staticconstexprprivate

Initial value:

=
        static_cast<scalar_type>(1e-8)

Default tolerance of residual norm.

Definition at line 168 of file avf4_formula.h.

integrand_

template<concepts::differentiable_problem Problem>

impl::avf_integrand<problem_type> num_collect::ode::avf::avf4_formula< Problem >::integrand_

private

Integrand.

Definition at line 158 of file avf4_formula.h.

integrator_

template<concepts::differentiable_problem Problem>

integration::gauss_legendre_integrator<variable_type(scalar_type)> num_collect::ode::avf::avf4_formula< Problem >::integrator_ {integrator_degree}

private

Integrator.

Definition at line 165 of file avf4_formula.h.

integrator_degree

template<concepts::differentiable_problem Problem>

index_type num_collect::ode::avf::avf4_formula< Problem >::integrator_degree = 5

staticconstexprprivate

Degree of integrator.

Definition at line 161 of file avf4_formula.h.

log_tag

template<concepts::differentiable_problem Problem>

auto num_collect::ode::avf::avf4_formula< Problem >::log_tag

staticconstexpr

Initial value:

=
        logging::log_tag_view("num_collect::ode::avf::avf4_formula")

Log tag.

Definition at line 68 of file avf4_formula.h.

order

template<concepts::differentiable_problem Problem>

index_type num_collect::ode::avf::avf4_formula< Problem >::order = 4

staticconstexpr

Order of this formula.

Definition at line 65 of file avf4_formula.h.

stages

template<concepts::differentiable_problem Problem>

index_type num_collect::ode::avf::avf4_formula< Problem >::stages = 1

staticconstexpr

Number of stages of this formula.

Definition at line 62 of file avf4_formula.h.

tol_residual_norm_

template<concepts::differentiable_problem Problem>

scalar_type num_collect::ode::avf::avf4_formula< Problem >::tol_residual_norm_ {default_tol_residual_norm}

private

Tolerance of residual norm.

Definition at line 172 of file avf4_formula.h.

---

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

• include/num_collect/ode/avf/avf4_formula.h