Quick References¶
For easy reference across all documents.
All documents about this project should use the same notations, symbols, and abbreviations as listed here.
Tip
You would grow this page as you write more documents and gain more insights into the domain. Do not worry about getting everything right the first time. You can always come back and update this page.
Units of Measurement¶
| Symbol | Unit | Description |
|---|---|---|
| \(\text{m}\) | meter | Length |
| \(\text{kg}\) | kilogram | Mass |
| \(\text{s}\) | second | Time |
Symbols Representations¶
| Symbol | Unit | Description |
|---|---|---|
| \(t\) | \(\text{s}\) | time since start of simulation |
| \(\bold{v}\) | \(\text{m/s}\) | velocity vector |
| \(\bold{a}\) | \(\text{m/s}^2\) | acceleration vector |
Abbreviations and Acronyms¶
| Symbol | Description |
|---|---|
| SRS | Software Requirements Specification |
| V&V | Verification and Validation |
| IC | Initial Conditions |
Also list them in this format, so a tooltip appears whenever user hovers over an abbreviation/acronym like SRS. The list itself is not visible in the rendered page.
Mathematical Notation¶
In all documents, the following notation is used:
- Bold font denotes vectors (e.g. \(\bold{v}\))
- | | denotes the modulus (magnitude) of a vector (e.g. \(|\bold{v}|\))
Key Concepts¶
These are domain specific concepts that may be common knowledge within the domain. However, for outside readers who just want to quickly go over the documents, they can use this section as a crash course.
Write these as a list as they can be longer and more detailed than the abbreviations/acronyms.
You may need to come back and add more as you write more documents. - Fluid Dynamics: The study of matters that can “flow”, including gases (like air) and liquids (like water), and how they interact with other objects (such as an aircraft).