Improvement of online docs for Fokker-Planck options #289
Conversation
This file contains 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
…s rather than using coord.element_scale and coord.element_shift for get_KJ_local!() matrix. Introduce initial explanatory documentation.
…for unused function.
…ALIBUR report and giving input parameter information. Modify the index to feature this note and the note on magnetic geometry.
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.
PR to address #152.
To do list:
fokker_planck.jland add sensible descriptions.fokker_planck_calculus.jland add sensible descriptions.fokker_planck_test.jland add sensible descriptions.gauss_legendre.jland add sensible descriptions.Please add to this checklist and I will try to satisfy your documentation requests. I would prefer not to provide more online documentation of the formal method until the paper which introduces this feature is accepted, to avoid duplicated effort. I am happy to document better where steps highlighted in the existing report are carried out.