num_prob_collect::ode::external_exponential_problem Class Reference

Class of test problem to calculate exponential function using external time-dependent term.. More...

#include <num_prob_collect/ode/external_exponential_problem.h>

Collaboration diagram for num_prob_collect::ode::external_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 time, double, num_collect::ode::evaluation_type)
	Evaluate on a (time, variable) pair.
auto	jacobian () const noexcept -> const jacobian_type &
	Get the Jacobian.
auto	time_derivative () const noexcept -> const variable_type &
	Get the partial derivative with respect to time.

Static Public Attributes
static constexpr auto	allowed_evaluations
	Allowed evaluations.

Private Attributes
double	diff_coeff_ {}
	Differential coefficient.
double	jacobian_ {1.0}
	Jacobian.
double	time_derivative_ {}
	Partial derivative with respect to time.

Detailed Description

Class of test problem to calculate exponential function using external time-dependent term..

Definition at line 33 of file external_exponential_problem.h.

Member Typedef Documentation

jacobian_type

using num_prob_collect::ode::external_exponential_problem::jacobian_type = double

Type of Jacobian.

Definition at line 42 of file external_exponential_problem.h.

scalar_type

using num_prob_collect::ode::external_exponential_problem::scalar_type = double

Type of scalars.

Definition at line 39 of file external_exponential_problem.h.

variable_type

using num_prob_collect::ode::external_exponential_problem::variable_type = double

Type of variables.

Definition at line 36 of file external_exponential_problem.h.

Member Function Documentation

diff_coeff()

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

inlinenodiscard

Get the differential coefficient.

Returns

Differential coefficient.

Definition at line 65 of file external_exponential_problem.h.

evaluate_on()

void num_prob_collect::ode::external_exponential_problem::evaluate_on ( double time, double , num_collect::ode::evaluation_type  )

inline

Evaluate on a (time, variable) pair.

Parameters

[in]

time

Time.

Definition at line 54 of file external_exponential_problem.h.

jacobian()

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

inlinenodiscardnoexcept

Get the Jacobian.

Returns

Jacobian.

Definition at line 74 of file external_exponential_problem.h.

time_derivative()

auto num_prob_collect::ode::external_exponential_problem::time_derivative ( ) const -> const variable_type&

inlinenodiscardnoexcept

Get the partial derivative with respect to time.

Returns

Derivative.

Definition at line 83 of file external_exponential_problem.h.

Member Data Documentation

allowed_evaluations

auto num_prob_collect::ode::external_exponential_problem::allowed_evaluations

staticconstexpr

Initial value:

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

Allowed evaluations.

Definition at line 45 of file external_exponential_problem.h.

diff_coeff_

double num_prob_collect::ode::external_exponential_problem::diff_coeff_ {}

private

Differential coefficient.

Definition at line 90 of file external_exponential_problem.h.

jacobian_

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

private

Jacobian.

Definition at line 93 of file external_exponential_problem.h.

time_derivative_

double num_prob_collect::ode::external_exponential_problem::time_derivative_ {}

private

Partial derivative with respect to time.

Definition at line 96 of file external_exponential_problem.h.

---

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

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