Opened 8 years ago

Closed 6 years ago

#4246 closed enhancement (fixed)

Make the documentation of Integration Methods consistent and up-to-date

Reported by: Francesco Casella Owned by: Willi Braun
Priority: blocker Milestone: 1.13.0
Component: Documentation Version:
Keywords: Cc:

Description

The online documentation on solver methods available here

https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/simulationflags.html#simflag-s

is too concise and inhomogeneous. In particular, for many algorithms it is not clear whether they do have error control and step-size/order adaptation or not.

Some more information is provided in another section of that document

https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/simulationflags.html#integration-methods

but only for some of the algorithms, and I am not sure it is up-to-date even for those ones. Overall, this is sometimes frustrating, and gives a bad impression about the software quality

I would suggest the following actions

  • make the information displayed under the -s=value section consistent w.r.t. the solver being fixed- or variable-step-size, i.e. either always mention this info, or never mention it
  • add a link to the detailed description to the -s=value text, e.g. "Value specifies the integration method. See <Integration Methods> for additional details"
  • update and complete the information shown in the Integration Methods section of the documentation, including a description of all the supported methods

Change History (8)

comment:1 by Willi Braun, 8 years ago

Status: newaccepted

comment:2 by Willi Braun, 7 years ago

Milestone: 2.0.01.13.0

comment:3 by Willi Braun, 7 years ago

The section of integration methods has been updated in PR69.

comment:4 by Francesco Casella, 7 years ago

I like the new section, which shows up here.

I would recommend to add a section on DAEmode, and also to put a cross reference to this section in the documentation of the -s flag.

comment:5 by Willi Braun, 6 years ago

Added DAEmode section in PR90.

in reply to:  4 comment:6 by Willi Braun, 6 years ago

Resolution: fixed
Status: acceptedclosed

Replying to casella:

I would recommend to add a section on DAEmode, and also to put a cross reference to this section in the documentation of the -s flag.

Done in PR2835.

comment:7 by Francesco Casella, 6 years ago

Resolution: fixed
Status: closedreopened

Please merge it also to the maintenance/v1.13 branch

comment:8 by Francesco Casella, 6 years ago

Resolution: fixed
Status: reopenedclosed
Note: See TracTickets for help on using tickets.