heyoka.var_args

heyoka.var_args#

flag heyoka.var_args(value)#

Enum for selecting variational arguments.

Added in version 5.0.0.

Values of this enum can be used in the constructor of var_ode_sys() to select the arguments with respect to which the variational equations will be formulated.

The enumerators can be combined with the logical OR | operator.

Examples:
>>> from heyoka import var_args
>>> va = var_args.vars | var_args.params # Select differentiation wrt all initial conditions and parameters
>>> var_args.vars | var_args.params | var_args.time == var_args.all
True

Valid values are as follows:

vars = <var_args.vars: 1>#

Differentiate with respect to the initial conditions of all state variables.

params = <var_args.params: 2>#

Differentiate with respect to all runtime parameters.

time = <var_args.time: 4>#

Differentiate with respect to the initial integration time.

Contents