Repository navigation
DOC: Make the user guide's examples converge as printed - #36
Merged
Merged
Conversation
A reader following the guide hit an unconverged single point and a polar with 13 of 41 points valid. Neither depends on the host: macOS, Linux arm64 and Linux x86_64 give identical results, and the reference XFOIL fails at the same points on the same panels. - The single-point examples used NACA 0012 at alpha 5, Re 1e6, which from a fresh start fails to converge in XFOIL and yFoil alike (4.5 and 5.5 converge); "Your first analysis" had sidestepped it with Re 1e9. Both now use alpha 4 at Re 1e6. - The Polars page never said how naca4412.json was made, and the only command producing it earlier in the guide (Geometry page) made a sharp-TE, 200-node section, on which the sweep halts at alpha 3. The Polars page now generates the section, and the Geometry example is the 160-node blunt TE. scripts/guide-figures.sh runs the new commands; naca0012_a5.fig becomes naca0012_a4.fig and the other figures regenerate byte-identical.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A reader following the getting-started guide on a Linux laptop reported that the single-point example (alpha 5) did not converge while lower alphas did, and that only a small part of the NACA 4412 polar was valid.
Findings
Neither depends on the host. macOS, Linux arm64 and Linux x86_64 (Ubuntu 24.04 containers) give identical panels, identical results and a byte-identical polar JSON. Both problems are in the docs:
VISCAL: Convergence failed), and at 4.5 it converges in 8 iterations, as yFoil does. "Your first analysis" had sidestepped this with Re 1e9.naca4412.jsonwas made. The only command producing it earlier in the guide, on the Geometry page, makes a sharp-TE, 200-node section. On that section the sweep fails from alpha 1.5 and halts after four failures at alpha 3, giving 13/41 valid. XFOIL does exactly the same (last converged alpha 1.0, CL 0.49137 in both). The 160-node blunt-TE section the docs figure was made from gives 41/41 valid.Changes
yfoil geometry naca 4412 -n 160 -o naca4412.json.--sharpis still documented further down that page.scripts/guide-figures.shruns the new commands.naca0012_a5.figbecomesnaca0012_a4.fig, and the other seven figures regenerate byte-identical.scripts/docs-check.pypasses.