gdtk-uq / gdtk

The Gas Dynamics Toolkit (GDTk) is a set of software tools for simulating high speed fluid flow, maintained at The University of Queensland and the University of Southern Queensland, Australia.
https://gdtk.uqcloud.net/
Other
59 stars 15 forks source link

Typo in User Guide, related to modal energy source terms #36

Closed uqngibbo closed 9 months ago

uqngibbo commented 11 months ago

Alexis Lefevre has discovered that the User Guide section on user defined source terms does not match the code.

Specifically the guide tells users to add the following keys to the table that gets passed upstairs to the D code:

In getUDFSourceTermsForCell in user_defined_source_terms.d however, the D code looks for keys without the "r". Commit 40b9c0c4046baaed4421512bcfdb13e90839a130 to the gdtk-docs repo changes the text to the following:

uqngibbo commented 11 months ago

Even though this issue is technically "fixed", we need to communicate this to users who may have saved versions of the PDF user guide.

rjgollan-on-github commented 11 months ago

The latest version of the User Guide PDF with Nick's amendments has been pushed up to the web server.

uqngibbo commented 9 months ago

This was addressed at a recent users meeting. Thanks Alexis for finding it!