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

#include <num_prob_collect/ode/exponential_problem.h>

Collaboration diagram for num_prob_collect::ode::exponential_problem:

Public Types
using	jacobian_type = double
	Type of Jacobian.

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.

Static Public Attributes
static constexpr auto	allowed_evaluations
	Allowed evaluations.

Private Attributes
double	diff_coeff_ {}
	Differential coefficient.

double	jacobian_ {1.0}
	Jacobian.

Detailed Description

Class of test problem to calculate exponential function.

Definition at line 29 of file exponential_problem.h.

Member Typedef Documentation

◆ jacobian_type

using num_prob_collect::ode::exponential_problem::jacobian_type = double

Type of Jacobian.

Definition at line 38 of file exponential_problem.h.

◆ scalar_type

using num_prob_collect::ode::exponential_problem::scalar_type = double

Type of scalars.

Definition at line 35 of file exponential_problem.h.

◆ variable_type

using num_prob_collect::ode::exponential_problem::variable_type = double

Type of variables.

Definition at line 32 of file exponential_problem.h.

Member Function Documentation

◆ diff_coeff()

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

inlinenodiscard

Get the differential coefficient.

Returns: Differential coefficient.

Definition at line 59 of file exponential_problem.h.

◆ evaluate_on()

void num_prob_collect::ode::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 49 of file exponential_problem.h.

◆ jacobian()

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

inlinenodiscardnoexcept

Get the Jacobian.

Returns: Jacobian.

Definition at line 68 of file exponential_problem.h.

Member Data Documentation

◆ allowed_evaluations

auto num_prob_collect::ode::exponential_problem::allowed_evaluations

staticconstexpr

Initial value:

=

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

num_collect::ode::evaluation_type

Struct to specify types of evaluations.

Definition evaluation_type.h:27

Allowed evaluations.

Definition at line 41 of file exponential_problem.h.

◆ diff_coeff_

double num_prob_collect::ode::exponential_problem::diff_coeff_ {}

private

Differential coefficient.

Definition at line 74 of file exponential_problem.h.

◆ jacobian_

double num_prob_collect::ode::exponential_problem::jacobian_ {1.0}

private

Jacobian.

Definition at line 77 of file exponential_problem.h.

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

problems/include/num_prob_collect/ode/exponential_problem.h

Public Types

Public Member Functions

Static Public Attributes

Private Attributes