DOC: Add setting descriptions for DE - #22
Open
mberz wants to merge 1 commit into
Open
Conversation
| }, | ||
| { | ||
| "name": "Energy decay threshold", | ||
| "description": "The energy decay threshold for determining the simulation length. Once the energy decays below this threshold, the simulation will terminate.", |
Contributor
There was a problem hiding this comment.
Maybe add at the start: "(Only used when the Simulation length is set to EDT.) The energy decay..." This way we're extra clear that whether this parameter has any effect is dependent on the Simulation length parameter.
| }, | ||
| { | ||
| "name": "Impulse response length", | ||
| "description": "The maximum length of the impulse response to be simulated.", |
| }, | ||
| { | ||
| "name": "Speed of sound", | ||
| "description": "Speed of sound in air filling the room.", |
Contributor
There was a problem hiding this comment.
"Speed of sound propagation in the simulated geometry volume."?
| }, | ||
| { | ||
| "name": "Characteristic length (mesh)", | ||
| "description": "Characteristic length of the mesh used in the simulation.", |
Contributor
There was a problem hiding this comment.
Maybe at the end: "(i.e., the approximate distance between two mesh nodes.)"
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
2 participants
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.
Proposed
implements choras-org/CHORAS#59