From 62e601d8a9809ab7cf8130334f7acc5ff0e8a7d4 Mon Sep 17 00:00:00 2001 From: ChrisZYJ Date: Mon, 29 Jul 2024 00:15:45 -0700 Subject: [PATCH] misc docs changes --- docs/documentation/case.md | 6 +++--- docs/documentation/getting-started.md | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/documentation/case.md b/docs/documentation/case.md index 0403ee8ac9..3bd5da5bbf 100644 --- a/docs/documentation/case.md +++ b/docs/documentation/case.md @@ -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 | @@ -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) | @@ -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. diff --git a/docs/documentation/getting-started.md b/docs/documentation/getting-started.md index 552152723e..e3b70833de 100644 --- a/docs/documentation/getting-started.md +++ b/docs/documentation/getting-started.md @@ -23,7 +23,6 @@ Please select your desired configuration from the list bellow: . ./mfc.sh load ``` - - **Via [Aptitude](https://wiki.debian.org/Aptitude):** ```shell @@ -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).