15#ifndef dealii_differentiation_ad_ad_drivers_h
16#define dealii_differentiation_ad_ad_drivers_h
29#ifdef DEAL_II_WITH_ADOLC
31# include <adolc/adouble.h>
32# include <adolc/adtl.h>
33# include <adolc/internal/usrparms.h>
59 "This function is called in a class that is expected to be specialized "
60 "for auto-differentiable numbers.");
67 "This function is only available if deal.II is compiled with ADOL-C.");
81 <<
"The number of derivative levels that this auto-differentiable number type supports is "
83 <<
", but to perform the intended operation the number must support at least "
84 << arg2 <<
" levels.");
93 template <
typename ADNumberType,
typename T =
void>
112 template <
typename ADNumberType,
typename T =
void>
128 std::numeric_limits<typename Types<ADNumberType>::tape_index>::max();
147 template <
typename ADNumberType,
typename ScalarType,
typename T =
void>
251 const bool write_tapes_to_file);
256 std::vector<typename Types<ADNumberType>::tape_index>
366 reset(
const bool clear_registered_tapes);
377 print(std::ostream &stream)
const;
389 std::ostream &stream)
const;
410 const std::vector<ScalarType> &independent_variables)
const;
427 const std::vector<ScalarType> &independent_variables,
445 const std::vector<ScalarType> &independent_variables,
469 const unsigned int n_dependent_variables,
470 const std::vector<ScalarType> &independent_variables,
493 const unsigned int n_dependent_variables,
494 const std::vector<ScalarType> &independent_variables,
517 template <
typename ADNumberType,
typename ScalarType,
typename T =
void>
593 value(
const std::vector<ADNumberType> &dependent_variables)
const;
609 gradient(
const std::vector<ADNumberType> &independent_variables,
610 const std::vector<ADNumberType> &dependent_variables,
627 hessian(
const std::vector<ADNumberType> &independent_variables,
628 const std::vector<ADNumberType> &dependent_variables,
648 values(
const std::vector<ADNumberType> &dependent_variables,
669 jacobian(
const std::vector<ADNumberType> &independent_variables,
670 const std::vector<ADNumberType> &dependent_variables,
690# ifdef DEAL_II_WITH_ADOLC
695 template <
typename ADNumberType>
696 struct Types<ADNumberType,
697 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
698 NumberTypes::adolc_taped>>
716 template <
typename ADNumberType>
717 struct Numbers<ADNumberType,
718 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
719 NumberTypes::adolc_taped>>
762 template <
typename ADNumberType>
766 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
767 NumberTypes::adolc_taped>>
769 using scalar_type = double;
809 const bool write_tapes_to_file);
811 std::vector<typename Types<ADNumberType>::tape_index>
828 reset(
const bool clear_registered_tapes);
831 print(std::ostream &stream)
const;
836 std::ostream &stream)
const;
847 const std::vector<scalar_type> &independent_variables)
const;
851 const std::vector<scalar_type> &independent_variables,
856 const std::vector<scalar_type> &independent_variables,
868 const unsigned int n_dependent_variables,
869 const std::vector<scalar_type> &independent_variables,
874 const unsigned int n_dependent_variables,
875 const std::vector<scalar_type> &independent_variables,
899 bool is_recording_flag;
928 mutable std::map<typename Types<ADNumberType>::tape_index,
int> status;
936 bool use_stored_taped_buffer_sizes;
969 template <
typename ADNumberType>
973 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
974 NumberTypes::adolc_taped>>
976 using scalar_type = double;
1009 std::vector<typename Types<ADNumberType>::tape_index>
1028 print(std::ostream &stream)
const;
1032 std::ostream &)
const;
1043 const std::vector<scalar_type> &)
const;
1047 const std::vector<scalar_type> &,
1052 const std::vector<scalar_type> &,
1065 const std::vector<scalar_type> &,
1071 const std::vector<scalar_type> &,
1087 template <
typename ADNumberType>
1088 struct TapedDrivers<
1091 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
1092 NumberTypes::adolc_taped>>
1094 using scalar_type = float;
1128 const bool write_tapes_to_file);
1130 std::vector<typename Types<ADNumberType>::tape_index>
1147 reset(
const bool clear_registered_tapes);
1150 print(std::ostream &stream)
const;
1155 std::ostream &stream)
const;
1166 const std::vector<scalar_type> &independent_variables)
const;
1170 const std::vector<scalar_type> &independent_variables,
1175 const std::vector<scalar_type> &independent_variables,
1187 const unsigned int n_dependent_variables,
1188 const std::vector<scalar_type> &independent_variables,
1193 const unsigned int n_dependent_variables,
1194 const std::vector<scalar_type> &independent_variables,
1204 vector_float_to_double(
const std::vector<float> &in)
const;
1209 TapedDrivers<ADNumberType, double> taped_driver;
1221 template <
typename ADNumberType,
typename ScalarType>
1222 struct TapelessDrivers<
1225 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
1226 NumberTypes::sacado_rad ||
1227 ADNumberTraits<ADNumberType>::type_code ==
1228 NumberTypes::sacado_rad_dfad>>
1267 value(
const std::vector<ADNumberType> &dependent_variables)
const;
1270 gradient(
const std::vector<ADNumberType> &independent_variables,
1271 const std::vector<ADNumberType> &dependent_variables,
1275 hessian(
const std::vector<ADNumberType> &independent_variables,
1276 const std::vector<ADNumberType> &dependent_variables,
1287 values(
const std::vector<ADNumberType> &dependent_variables,
1291 jacobian(
const std::vector<ADNumberType> &independent_variables,
1292 const std::vector<ADNumberType> &dependent_variables,
1302 bool dependent_variable_marking_safe;
1311 template <
typename ADNumberType,
typename ScalarType>
1312 struct TapelessDrivers<
1315 std::enable_if_t<ADNumberTraits<ADNumberType>::type_code ==
1316 NumberTypes::adolc_tapeless ||
1317 ADNumberTraits<ADNumberType>::type_code ==
1318 NumberTypes::sacado_dfad ||
1319 ADNumberTraits<ADNumberType>::type_code ==
1320 NumberTypes::sacado_dfad_dfad>>
1359 value(
const std::vector<ADNumberType> &dependent_variables)
const;
1362 gradient(
const std::vector<ADNumberType> &independent_variables,
1363 const std::vector<ADNumberType> &dependent_variables,
1367 hessian(
const std::vector<ADNumberType> &independent_variables,
1368 const std::vector<ADNumberType> &dependent_variables,
1379 values(
const std::vector<ADNumberType> &dependent_variables,
1383 jacobian(
const std::vector<ADNumberType> &independent_variables,
1384 const std::vector<ADNumberType> &dependent_variables,
1394 bool dependent_variable_marking_safe;
#define DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_CLOSE
static ::ExceptionBase & ExcSupportedDerivativeLevels(std::size_t arg1, std::size_t arg2)
static ::ExceptionBase & ExcRequiresADNumberSpecialization()
static ::ExceptionBase & ExcRequiresADOLC()
#define DeclException2(Exception2, type1, type2, outsequence)
#define DeclExceptionMsg(Exception, defaulttext)
static const Types< ADNumberType >::tape_index max_tape_index
static const Types< ADNumberType >::tape_index invalid_tape_index
void gradient(const typename Types< ADNumberType >::tape_index active_tape_index, const std::vector< ScalarType > &independent_variables, Vector< ScalarType > &gradient) const
bool is_recording() const
bool is_registered_tape(const typename Types< ADNumberType >::tape_index tape_index) const
void stop_taping(const typename Types< ADNumberType >::tape_index active_tape_index, const bool write_tapes_to_file)
void remove_tape(const typename Types< ADNumberType >::tape_index tape_index)
void start_taping(const typename Types< ADNumberType >::tape_index tape_index, const bool keep_independent_values)
void hessian(const typename Types< ADNumberType >::tape_index active_tape_index, const std::vector< ScalarType > &independent_variables, FullMatrix< ScalarType > &hessian) const
void set_tape_buffer_sizes(const typename Types< ADNumberType >::tape_buffer_sizes obufsize=64 *1024 *1024, const typename Types< ADNumberType >::tape_buffer_sizes lbufsize=64 *1024 *1024, const typename Types< ADNumberType >::tape_buffer_sizes vbufsize=64 *1024 *1024, const typename Types< ADNumberType >::tape_buffer_sizes tbufsize=64 *1024 *1024)
void activate_tape(const typename Types< ADNumberType >::tape_index tape_index)
bool last_action_requires_retaping() const
bool requires_retaping(const typename Types< ADNumberType >::tape_index tape_index) const
void print(std::ostream &stream) const
void print_tape_stats(const typename Types< ADNumberType >::tape_index tape_index, std::ostream &stream) const
ScalarType value(const typename Types< ADNumberType >::tape_index active_tape_index, const std::vector< ScalarType > &independent_variables) const
bool keep_independent_values() const
Types< ADNumberType >::tape_index active_tape_index() const
void reset(const bool clear_registered_tapes)
std::vector< typename Types< ADNumberType >::tape_index > get_registered_tape_indices() const
void values(const typename Types< ADNumberType >::tape_index active_tape_index, const unsigned int n_dependent_variables, const std::vector< ScalarType > &independent_variables, Vector< ScalarType > &values) const
void jacobian(const typename Types< ADNumberType >::tape_index active_tape_index, const unsigned int n_dependent_variables, const std::vector< ScalarType > &independent_variables, FullMatrix< ScalarType > &jacobian) const
void gradient(const std::vector< ADNumberType > &independent_variables, const std::vector< ADNumberType > &dependent_variables, Vector< ScalarType > &gradient) const
void allow_dependent_variable_marking()
void hessian(const std::vector< ADNumberType > &independent_variables, const std::vector< ADNumberType > &dependent_variables, FullMatrix< ScalarType > &hessian) const
void values(const std::vector< ADNumberType > &dependent_variables, Vector< ScalarType > &values) const
void jacobian(const std::vector< ADNumberType > &independent_variables, const std::vector< ADNumberType > &dependent_variables, FullMatrix< ScalarType > &jacobian) const
static void initialize_global_environment(const unsigned int n_independent_variables)
bool is_dependent_variable_marking_allowed() const
ScalarType value(const std::vector< ADNumberType > &dependent_variables) const
void prevent_dependent_variable_marking()
unsigned int tape_buffer_sizes