DOCUMENTATION: Improve explanation of nsubsteps
usage
#314
Labels
documentation
Improvements or additions to documentation
nsubsteps
usage
#314
Derived from #307.
To my understanding, WecOptTool currently uses substeps for two purposes:
nsubsteps
to dynamics equality constraint #307 (comment))The documentation is rather indirect about these two uses: Tutorial 1 broadly points to the Theory documentation for an explanation of using substeps in constraints without specifying where, and then is a bit handwavy for its use for post-processing. The Theory documentation does include some explanation in the Constraints section):
This could probably be improved, as "it may be required" could be changed to explain why you would want to use substeps specifically for the constraints instead of changing the frequency vector.
Overall, I think the use of
nsubsteps
could be clarified in a number of ways:linkcheck
, but this is not a concern since this was removed in Remove linkcheck #287)nsubsteps
for the constraints and for post-processing could be clarified, either by providing language for this in Tutorial 1, or perhaps by changing the variable name to something else for one of these, since it is two rather distinct uses for the same variable nameThe text was updated successfully, but these errors were encountered: