Skip to content

Commit

Permalink
misc docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisZYJ committed Jul 29, 2024
1 parent cff8f53 commit 62e601d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/documentation/case.md
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ If `file_per_process` is true, then pre_process, simulation, and post_process mu
| `acoustic_source` | Logical | Acoustic source module activation |
| `num_source` | Integer | Number of acoustic sources |
| `acoustic(i)%%support` | Integer | Geometry of spatial support for the acoustic source |
| `acoustic(i)%%dipole` | Logical | Dipole source activation (optional; default = false for monopole) |
| `acoustic(i)%%dipole` | Logical | Dipole source activation (optional; default = false -> monopole) |
| `acoustic(i)%%loc(j)` | Real | $j$-th coordinate of the point that defines the acoustic source location |
| `acoustic(i)%%pulse` | Integer | Acoustic wave form: [1] Sine [2] Gaussian [3] Square |
| `acoustic(i)%%npulse` | Real | Number of pulse cycles |
Expand All @@ -532,7 +532,7 @@ If `file_per_process` is true, then pre_process, simulation, and post_process mu
| `acoustic(i)%%foc_length` | Real | Transducer - Focal length of the transducer |
| `acoustic(i)%%aperture` | Real | Transducer - Aperture of the transducer |
| `acoustic(i)%%num_elements` | Integer | Transducer array - Number of transducer elements in a transducer array |
| `acoustic(i)%%element_on` | Integer | Transducer array - Element number that is on (optional; default = 0 for all elements) |
| `acoustic(i)%%element_on` | Integer | Transducer array - Element number that is on (optional; default = 0 -> all elements) |
| `acoustic(i)%%element_spacing_angle` | Real | 2D Transducer array - Spacing angle (in rad) between adjacent transducer elements |
| `acoustic(i)%%element_polygon_ratio` | Real | 3D Transducer array - Ratio of polygon side length to transducer element radius |
| `acoustic(i)%%rotate_angle` | Real | 3D Transducer array - Rotation angle of the transducer array (optional; default = 0) |
Expand Down Expand Up @@ -808,7 +808,7 @@ Each patch requires a different set of parameters, which are also listed in this
| 7 | Spherical Transducer | 3D | #5 requirements and `%%loc(3)` |
| 9 | Arcuate Transducer Array | 2D | #5 requirements, `%%num_elements`, `%%element_on`, `%%element_spacing_angle` |
| 10 | Annular Transducer Array | 2D-Axisym | #9 requirements |
| 11 | Circular Transducer Array | 3D | #7 requirements, `%%element_polygon_ratio`, and `%%rotate_angle`(optional; default = 0) |
| 11 | Circular Transducer Array | 3D | #7 requirements, `%%element_polygon_ratio`, and `%%rotate_angle` |

Details of the required parameters for each acoustic support type are listed in [Acoustic Source](#acoustic-source).
The acoustic support number (`#`) corresponds to the acoustic support type `Acoustic(i)%%support`, where $i$ is the acoustic source index.
Expand Down
3 changes: 1 addition & 2 deletions docs/documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Please select your desired configuration from the list bellow:
. ./mfc.sh load
```

<a id="via-aptitude"></a>
- **Via [Aptitude](https://wiki.debian.org/Aptitude):**

```shell
Expand Down Expand Up @@ -77,7 +76,7 @@ Useful software to install for using WSL on Windows:
- [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701)
- [Visual Studio Code](https://code.visualstudio.com/) and the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension

Once you have WSL installed, you can follow the instructions for *nix systems above (for Ubuntu, see [Via Aptitude](#via-aptitude)).
Once you have WSL installed, you can follow the instructions for *nix systems above (for Ubuntu, see `Via Aptitude` section).

</details>

Expand Down

0 comments on commit 62e601d

Please sign in to comment.