Stan Math Library  2.20.0
reverse mode automatic differentiation
Public Member Functions | Static Public Attributes | List of all members
stan::math::idas_integrator Class Reference

IDAS DAE integrator. More...

#include <idas_integrator.hpp>

Public Member Functions

 idas_integrator (const double rtol, const double atol, const int64_t max_num_steps=IDAS_MAX_STEPS)
 constructor More...
 
template<typename Dae >
Dae::return_type integrate (Dae &dae, double t0, const std::vector< double > &ts)
 Return the solutions for the specified DAE given the specified initial state, initial times, times of desired solution, and parameters and data, writing error and warning messages to the specified stream contained in the DAE system. More...
 

Static Public Attributes

static constexpr int IDAS_MAX_STEPS = 500
 

Detailed Description

IDAS DAE integrator.

Definition at line 26 of file idas_integrator.hpp.

Constructor & Destructor Documentation

◆ idas_integrator()

stan::math::idas_integrator::idas_integrator ( const double  rtol,
const double  atol,
const int64_t  max_num_steps = IDAS_MAX_STEPS 
)
inline

constructor

Parameters
[in]rtolrelative tolerance
[in]atolabsolute tolerance
[in]max_num_stepsmax nb. of times steps

Definition at line 81 of file idas_integrator.hpp.

Member Function Documentation

◆ integrate()

template<typename Dae >
Dae::return_type stan::math::idas_integrator::integrate ( Dae &  dae,
double  t0,
const std::vector< double > &  ts 
)
inline

Return the solutions for the specified DAE given the specified initial state, initial times, times of desired solution, and parameters and data, writing error and warning messages to the specified stream contained in the DAE system.

Template Parameters
DAEtype of DAE system
Parameters
[in]daeDAE system
[in]t0initial time.
[in]tstimes of the desired solutions, in strictly increasing order, all greater than the initial time.
Returns
a vector of states, each state being a vector of the same size as the state variable, corresponding to a time in ts.

Definition at line 114 of file idas_integrator.hpp.

Member Data Documentation

◆ IDAS_MAX_STEPS

constexpr int stan::math::idas_integrator::IDAS_MAX_STEPS = 500
static

Definition at line 74 of file idas_integrator.hpp.


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

     [ Stan Home Page ] © 2011–2018, Stan Development Team.