num_prob_collect::ode::changing_mass_exponential_problem Class Reference

Class of test problem to calculate exponential function. More...

#include <num_prob_collect/ode/changing_mass_exponential_problem.h>

Collaboration diagram for num_prob_collect::ode::changing_mass_exponential_problem:

Public Types
using	jacobian_type = double
	Type of Jacobian.
using	mass_type = double
	Type of mass.
using	scalar_type = double
	Type of scalars.
using	variable_type = double
	Type of variables.

Public Member Functions
auto	diff_coeff () const -> const double &
	Get the differential coefficient.
void	evaluate_on (double, double variable, num_collect::ode::evaluation_type)
	Evaluate on a (time, variable) pair.
auto	jacobian () const noexcept -> const jacobian_type &
	Get the Jacobian.
auto	mass () const noexcept -> const mass_type &
	Get the mass.

Static Public Attributes
static constexpr auto	allowed_evaluations
	Allowed evaluations.

Private Attributes
double	diff_coeff_ {}
	Differential coefficient.
double	jacobian_ {}
	Jacobian.
double	mass_ {}
	Mass.

Detailed Description

Class of test problem to calculate exponential function.

Definition at line 33 of file changing_mass_exponential_problem.h.

Member Typedef Documentation

jacobian_type

using num_prob_collect::ode::changing_mass_exponential_problem::jacobian_type = double

Type of Jacobian.

Definition at line 42 of file changing_mass_exponential_problem.h.

mass_type

using num_prob_collect::ode::changing_mass_exponential_problem::mass_type = double

Type of mass.

Definition at line 45 of file changing_mass_exponential_problem.h.

scalar_type

using num_prob_collect::ode::changing_mass_exponential_problem::scalar_type = double

Type of scalars.

Definition at line 39 of file changing_mass_exponential_problem.h.

variable_type

using num_prob_collect::ode::changing_mass_exponential_problem::variable_type = double

Type of variables.

Definition at line 36 of file changing_mass_exponential_problem.h.

Member Function Documentation

diff_coeff()

auto num_prob_collect::ode::changing_mass_exponential_problem::diff_coeff ( ) const -> const double&

inlinenodiscard

Get the differential coefficient.

Returns

Differential coefficient.

Definition at line 70 of file changing_mass_exponential_problem.h.

evaluate_on()

void num_prob_collect::ode::changing_mass_exponential_problem::evaluate_on ( double , double variable, num_collect::ode::evaluation_type  )

inline

Evaluate on a (time, variable) pair.

Parameters

[in]

variable

Variable.

Definition at line 57 of file changing_mass_exponential_problem.h.

jacobian()

auto num_prob_collect::ode::changing_mass_exponential_problem::jacobian ( ) const -> const jacobian_type&

inlinenodiscardnoexcept

Get the Jacobian.

Returns

Jacobian.

Definition at line 79 of file changing_mass_exponential_problem.h.

mass()

auto num_prob_collect::ode::changing_mass_exponential_problem::mass ( ) const -> const mass_type&

inlinenodiscardnoexcept

Get the mass.

Returns

Mass.

Definition at line 88 of file changing_mass_exponential_problem.h.

Member Data Documentation

allowed_evaluations

auto num_prob_collect::ode::changing_mass_exponential_problem::allowed_evaluations

staticconstexpr

Initial value:

=
        num_collect::ode::evaluation_type{
            .diff_coeff = true, .jacobian = true, .mass = true}

Allowed evaluations.

Definition at line 48 of file changing_mass_exponential_problem.h.

diff_coeff_

double num_prob_collect::ode::changing_mass_exponential_problem::diff_coeff_ {}

private

Differential coefficient.

Definition at line 94 of file changing_mass_exponential_problem.h.

jacobian_

double num_prob_collect::ode::changing_mass_exponential_problem::jacobian_ {}

private

Jacobian.

Definition at line 100 of file changing_mass_exponential_problem.h.

mass_

double num_prob_collect::ode::changing_mass_exponential_problem::mass_ {}

private

Mass.

Definition at line 97 of file changing_mass_exponential_problem.h.

---

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

• problems/include/num_prob_collect/ode/changing_mass_exponential_problem.h