gemseo.disciplines.ode.base_functor module#

A discipline for solving ordinary differential equations (ODEs).

class BaseFunctor(ode_discipline, discipline, state_names, time_name)[source]#

Bases: object

A function wrapping a RHS discipline.

This function has time and state as arguments, and an attribute 'terminal'.

Its subclasses are used to evaluate the outputs of the RHS discipline or its Jacobian.

Parameters:

  • ode_discipline (ODEDiscipline) -- The ODE discipline providing the local data.

  • discipline (Discipline) -- The wrapped discipline defining the dynamic.

  • state_names (Iterable[str] | Mapping[str, str]) -- Either the names of the state variables, passed as (state_name, ...), or the names of the state variables bound to the associated discipline outputs, passed as {state_name: output_name, ...}.

  • time_name (str) -- The name of the time variables.

terminal: bool#

An attribute used by ODE libraries.