num_collect::ode::avf::impl::avf_integrand< Problem > Class Template Reference

Class of integrand for average vector field (AVF) method [21]. More...

#include <num_collect/ode/avf/impl/avf_integrand.h>

Inheritance diagram for num_collect::ode::avf::impl::avf_integrand< Problem >:

Collaboration diagram for num_collect::ode::avf::impl::avf_integrand< Problem >:

Public Types
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
	avf_integrand (const problem_type &problem=problem_type())
	Constructor.
void	next_var (const variable_type &var)
	Set the next variable.
auto	operator() (scalar_type rate) const -> variable_type
	Calculate integrand.
void	prev_var (const variable_type &var)
	Set the previous variable.
auto	problem () -> problem_type &
	Get the problem.
auto	problem () const -> const problem_type &
	Get the problem.
void	time (scalar_type val)
	Set time.

Private Attributes
variable_type	next_var_ {}
	Next variable.
variable_type	prev_var_ {}
	Previous variable.
problem_type	problem_
	Problem.
scalar_type	time_ {}
	Time.

Detailed Description

template<concepts::problem Problem>
class num_collect::ode::avf::impl::avf_integrand< Problem >

Class of integrand for average vector field (AVF) method [21].

Template Parameters

Problem

Type of problem.

Definition at line 35 of file avf_integrand.h.

Member Typedef Documentation

problem_type

template<concepts::problem Problem>

using num_collect::ode::avf::impl::avf_integrand< Problem >::problem_type = Problem

Type of problem.

Definition at line 38 of file avf_integrand.h.

scalar_type

template<concepts::problem Problem>

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

Type of scalars.

Definition at line 44 of file avf_integrand.h.

variable_type

template<concepts::problem Problem>

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

Type of variables.

Definition at line 41 of file avf_integrand.h.

Constructor & Destructor Documentation

avf_integrand()

template<concepts::problem Problem>

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

inlineexplicit

Constructor.

Parameters

[in]

problem

Problem.

Definition at line 54 of file avf_integrand.h.

Member Function Documentation

next_var()

template<concepts::problem Problem>

void num_collect::ode::avf::impl::avf_integrand< Problem >::next_var ( const variable_type & var )

inline

Set the next variable.

Parameters

[in]

var

Variable.

Definition at line 105 of file avf_integrand.h.

operator()()

template<concepts::problem Problem>

auto num_collect::ode::avf::impl::avf_integrand< Problem >::operator() ( scalar_type rate ) const -> variable_type

inlinenodiscard

Calculate integrand.

Parameters

[in]

rate

Rate of variable.

Returns

Value of integrand.

Definition at line 63 of file avf_integrand.h.

prev_var()

template<concepts::problem Problem>

void num_collect::ode::avf::impl::avf_integrand< Problem >::prev_var ( const variable_type & var )

inline

Set the previous variable.

Parameters

[in]

var

Variable.

Definition at line 98 of file avf_integrand.h.

problem() [1/2]

template<concepts::problem Problem>

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

inlinenodiscard

Get the problem.

Returns

Problem.

Definition at line 75 of file avf_integrand.h.

problem() [2/2]

template<concepts::problem Problem>

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

inlinenodiscard

Get the problem.

Returns

Problem.

Definition at line 82 of file avf_integrand.h.

time()

template<concepts::problem Problem>

void num_collect::ode::avf::impl::avf_integrand< Problem >::time ( scalar_type val )

inline

Set time.

Parameters

[in]

val

Value.

Definition at line 91 of file avf_integrand.h.

Member Data Documentation

next_var_

template<concepts::problem Problem>

variable_type num_collect::ode::avf::impl::avf_integrand< Problem >::next_var_ {}

private

Next variable.

Definition at line 118 of file avf_integrand.h.

prev_var_

template<concepts::problem Problem>

variable_type num_collect::ode::avf::impl::avf_integrand< Problem >::prev_var_ {}

private

Previous variable.

Definition at line 115 of file avf_integrand.h.

problem_

template<concepts::problem Problem>

problem_type num_collect::ode::avf::impl::avf_integrand< Problem >::problem_

mutableprivate

Problem.

Definition at line 109 of file avf_integrand.h.

time_

template<concepts::problem Problem>

scalar_type num_collect::ode::avf::impl::avf_integrand< Problem >::time_ {}

private

Time.

Definition at line 112 of file avf_integrand.h.

---

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

• include/num_collect/ode/avf/impl/avf_integrand.h