Icarus
Vehicle Simulation as a Transformable Computational Graph, built on Vulcan and Janus
Loading...
Searching...
No Matches
icarus::IntegrationError Class Reference

Integration/ODE solver errors with time context. More...

#include <Error.hpp>

Inheritance diagram for icarus::IntegrationError:
Collaboration diagram for icarus::IntegrationError:

Public Member Functions

 IntegrationError (const std::string &msg)
 IntegrationError (double t, double dt, const std::string &reason)
std::optional< double > t () const
std::optional< double > dt () const
Public Member Functions inherited from icarus::Error
 Error (const std::string &msg, Severity severity=Severity::ERROR, std::string category="general")
Severity severity () const
const std::string & category () const
SimulationError toSimulationError (double time=0.0, const std::string &component="") const
 Convert to SimulationError for ErrorHandler integration.

Static Public Member Functions

static IntegrationError StepTooSmall (double min_dt)

Additional Inherited Members

Protected Attributes inherited from icarus::Error
Severity severity_
std::string category_

Detailed Description

Integration/ODE solver errors with time context.

Constructor & Destructor Documentation

◆ IntegrationError() [1/2]

icarus::IntegrationError::IntegrationError ( const std::string & msg)
inlineexplicit

◆ IntegrationError() [2/2]

icarus::IntegrationError::IntegrationError ( double t,
double dt,
const std::string & reason )
inline

Member Function Documentation

◆ dt()

std::optional< double > icarus::IntegrationError::dt ( ) const
inlinenodiscard

◆ StepTooSmall()

IntegrationError icarus::IntegrationError::StepTooSmall ( double min_dt)
inlinestatic

◆ t()

std::optional< double > icarus::IntegrationError::t ( ) const
inlinenodiscard

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