Skip to content

docs: add disclaimer about non-Hamiltonian flows (JOSS reviewer @giovannifereoli, round 2)#800

Merged
ocots merged 2 commits into
jossfrom
joss-reviewer-giovannifereoli
Jun 11, 2026
Merged

docs: add disclaimer about non-Hamiltonian flows (JOSS reviewer @giovannifereoli, round 2)#800
ocots merged 2 commits into
jossfrom
joss-reviewer-giovannifereoli

Conversation

@ocots

@ocots ocots commented Jun 11, 2026

Copy link
Copy Markdown
Member

Context

This PR addresses point 2 of the second-round review by @giovannifereoli for the JOSS submission (openjournals/joss-reviews#10630).

The reviewer asked for a clear disclaimer about the current limitation of indirect methods to Hamiltonian flows, and the planned future support for non-Hamiltonian flows.

Changes

joss/paper.md

Extended the Indirect methods bullet in the Software Design section with a closing sentence:

Currently, indirect methods are limited to Hamiltonian flows, where the feedback control law depends on both state and costate; support for non-Hamiltonian flows (open-loop or state-feedback control laws) is under active development.

docs/src/manual-flow-ocp.md

Added a note admonition at the very top of the flow-from-OCP tutorial, before any code example:

Current limitation: Currently, from an optimal control problem, only Hamiltonian flows can be constructed, i.e. the control law must be provided in feedback form depending on both state and costate: u(x, p). An active refactoring is under way to extend support to non-Hamiltonian flows, in particular open-loop control laws u(t) and state feedback control laws u(x).

This placement is the most visible for users actually working with the Flow function from an OCP.

- joss/paper.md: append sentence to the Indirect methods bullet in the
  Software Design section noting that indirect methods are currently
  limited to Hamiltonian flows (u(x,p)) and that support for
  non-Hamiltonian flows is under active development
- docs/src/manual-flow-ocp.md: add a prominent note admonition at the
  top of the flow-from-OCP tutorial, before any code example, explaining
  the same limitation and listing the planned extensions (open-loop u(t)
  and state-feedback u(x))
@ocots ocots added the run documentation Trigger Documentation label Jun 11, 2026
@ocots ocots merged commit 7b6d577 into joss Jun 11, 2026
6 checks passed
@ocots ocots deleted the joss-reviewer-giovannifereoli branch June 11, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

run documentation Trigger Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants