numerical-collection-cpp 0.10.0
A collection of algorithms in numerical analysis implemented in C++
Loading...
Searching...
No Matches
num_collect::ode::single_variate_implicit_problem_wrapper< Problem > Class Template Reference

Class to wrap implicit problems to use as explicit problems. More...

#include <num_collect/ode/implicit_problem_wrapper.h>

+ Collaboration diagram for num_collect::ode::single_variate_implicit_problem_wrapper< Problem >:

Public Types

using scalar_type = typename Problem::scalar_type
 Type of scalars.
 
using variable_type = typename Problem::variable_type
 Type of variables.
 

Public Member Functions

 single_variate_implicit_problem_wrapper (Problem problem)
 Constructor.
 
auto diff_coeff () const noexcept -> const variable_type &
 Get the differential coefficient.
 
void evaluate_on (const scalar_type &time, const variable_type &variable, evaluation_type)
 Evaluate on a (time, variable) pair.
 

Static Public Attributes

static constexpr auto allowed_evaluations
 Allowed evaluations.
 

Private Attributes

variable_type diff_coeff_ {}
 Differential coefficient.
 
Problem problem_
 Problem.
 

Detailed Description

template<concepts::single_variate_problem Problem>
requires concepts::mass_problem<Problem>
class num_collect::ode::single_variate_implicit_problem_wrapper< Problem >

Class to wrap implicit problems to use as explicit problems.

Template Parameters
ProblemType of the problem.

Definition at line 43 of file implicit_problem_wrapper.h.

Member Typedef Documentation

◆ scalar_type

template<concepts::single_variate_problem Problem>
using num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::scalar_type = typename Problem::scalar_type

Type of scalars.

Definition at line 49 of file implicit_problem_wrapper.h.

◆ variable_type

template<concepts::single_variate_problem Problem>
using num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::variable_type = typename Problem::variable_type

Type of variables.

Definition at line 46 of file implicit_problem_wrapper.h.

Constructor & Destructor Documentation

◆ single_variate_implicit_problem_wrapper()

template<concepts::single_variate_problem Problem>
num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::single_variate_implicit_problem_wrapper ( Problem problem)
inlineexplicit

Constructor.

Parameters
[in]problemProblem.

Definition at line 60 of file implicit_problem_wrapper.h.

Member Function Documentation

◆ diff_coeff()

template<concepts::single_variate_problem Problem>
auto num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::diff_coeff ( ) const -> const variable_type&
inlinenodiscardnoexcept

Get the differential coefficient.

Returns
Differential coefficient.

Definition at line 81 of file implicit_problem_wrapper.h.

◆ evaluate_on()

template<concepts::single_variate_problem Problem>
void num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::evaluate_on ( const scalar_type & time,
const variable_type & variable,
evaluation_type  )
inline

Evaluate on a (time, variable) pair.

Parameters
[in]timeTime.
[in]variableVariable.

Definition at line 69 of file implicit_problem_wrapper.h.

Member Data Documentation

◆ allowed_evaluations

template<concepts::single_variate_problem Problem>
auto num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::allowed_evaluations
staticconstexpr
Initial value:
=
Struct to specify types of evaluations.

Allowed evaluations.

Definition at line 52 of file implicit_problem_wrapper.h.

◆ diff_coeff_

template<concepts::single_variate_problem Problem>
variable_type num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::diff_coeff_ {}
private

Differential coefficient.

Definition at line 90 of file implicit_problem_wrapper.h.

◆ problem_

template<concepts::single_variate_problem Problem>
Problem num_collect::ode::single_variate_implicit_problem_wrapper< Problem >::problem_
private

Problem.

Definition at line 87 of file implicit_problem_wrapper.h.


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