metis::SensitivityRecommendation Struct Reference

Result of Metis sensitivity regime selection. More...

#include <AutoDiff.hpp>

Public Member Functions
bool	uses_forward_mode () const
bool	uses_reverse_mode () const
bool	uses_checkpointing () const
int	casadi_direction_count () const
casadi::Dict	integrator_options () const
	Convert the recommendation into SUNDIALS/CasADi integrator options.

Public Attributes
SensitivityRegime	regime = SensitivityRegime::Forward
CheckpointInterpolation	checkpoint_interpolation = CheckpointInterpolation::None
int	parameter_count = 0
int	output_count = 0
int	horizon_length = 1
int	steps_per_checkpoint = 0
bool	stiff = false

Detailed Description

Result of Metis sensitivity regime selection.

Member Function Documentation

casadi_direction_count()

int metis::SensitivityRecommendation::casadi_direction_count ( ) const

inline

integrator_options()

casadi::Dict metis::SensitivityRecommendation::integrator_options ( ) const

inline

Convert the recommendation into SUNDIALS/CasADi integrator options.

This is intended for downstream integrator construction. It exposes the same regime choice through nfwd/nadj and, for long-horizon adjoints, checkpoint interpolation and spacing.

uses_checkpointing()

bool metis::SensitivityRecommendation::uses_checkpointing ( ) const

inline

uses_forward_mode()

bool metis::SensitivityRecommendation::uses_forward_mode ( ) const

inline

uses_reverse_mode()

bool metis::SensitivityRecommendation::uses_reverse_mode ( ) const

inline

Member Data Documentation

checkpoint_interpolation

CheckpointInterpolation metis::SensitivityRecommendation::checkpoint_interpolation = CheckpointInterpolation::None

horizon_length

int metis::SensitivityRecommendation::horizon_length = 1

output_count

int metis::SensitivityRecommendation::output_count = 0

parameter_count

int metis::SensitivityRecommendation::parameter_count = 0

regime

SensitivityRegime metis::SensitivityRecommendation::regime = SensitivityRegime::Forward

steps_per_checkpoint

int metis::SensitivityRecommendation::steps_per_checkpoint = 0

stiff

bool metis::SensitivityRecommendation::stiff = false

---

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

• include/metis/math/AutoDiff.hpp