You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/documentation/case.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,7 @@ The code outputs error messages when an empty region is left in the domain.
182
182
Some parameters, as described above, can be defined by analytical functions in the input file. For example, one can define the following patch:
183
183
184
184
```shell
185
-
'patch_icpp(2)%geometry':15,
185
+
'patch_icpp(2)%geometry':1,
186
186
'patch_icpp(2)%x_centroid': 0.25,
187
187
'patch_icpp(2)%length_x': 9.5,
188
188
'patch_icpp(2)%vel(1)': 0.,
@@ -228,7 +228,7 @@ For example, to add a 2D Hardcoded patch with an id of 200, one would add the fo
228
228
229
229
and use `patch_icpp(i)%%geometry = 7` and `patch_icpp(i)%%hcid = 200` in the input file.
230
230
Additional variables can be declared in `Hardcoded1[2,3]DVariables` and used in `hardcoded1[2,3]D`.
231
-
As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indites the number of dimensions.
231
+
As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indicates the number of dimensions.
232
232
233
233
#### Parameter Descriptions
234
234
@@ -353,9 +353,9 @@ Details of implementation of viscosity in MFC can be found in [Coralic (2015)](r
|`weno_avg`| Logical | Arithmetic mean of left and right, WENO-reconstructed, cell-boundary values |
360
360
|`dt`| Real | Time step size |
361
361
|`t_step_start`| Integer | Simulation starting time step |
@@ -434,7 +434,7 @@ Practically, `weno_eps` $<10^{-6}$ is used.
434
434
-`wave_speeds` specifies the choice of the method to compute the left, right, and middle wave speeds in the Riemann solver by an integer of 1 and 2.
435
435
`wave_speeds = 1` and `2` correspond to the direct method ([Batten et al., 1997](references.md#Batten97)), and indirect method that approximates the pressures and velocity ([Toro, 2013](references.md#Toro13)), respectively.
436
436
437
-
-`weno_Re_flux` activates the scaler divergence theorem in computing the velocity gradients using WENO-reconstructed cell boundary values.
437
+
-`weno_Re_flux` activates the scalar divergence theorem in computing the velocity gradients using WENO-reconstructed cell boundary values.
438
438
If this option is false, velocity gradient is computed using finite difference scheme of order 2 which is independent of the WENO order.
439
439
440
440
-`weno_avg` it activates the arithmetic average of the left and right, WENO-reconstructed, cell-boundary values.
@@ -592,7 +592,7 @@ Details of the transducer acoustic source model can be found in [Maeda and Colon
592
592
593
593
-`%%element_on` specifies the element number of the transducer array that is on. The element number starts from 1. If all elements are on, set `%%element_on` to 0.
594
594
595
-
-`%%element_spacing_angle` specifies the spacing angle between adjacent transducer in radian. The total aperture (`%%aperture`) is set, so each transducer element is smaller if `%%element_spacing_angle` is larger.
595
+
-`%%element_spacing_angle` specifies the spacing angle between adjacent transducer in radians. The total aperture (`%%aperture`) is set, so each transducer element is smaller if `%%element_spacing_angle` is larger.
596
596
597
597
-`%%element_polygon_ratio` specifies the ratio of the polygon side length to the aperture diameter of each transducer element in a circular 3D transducer array. The polygon side length is calculated by using the total aperture (`%%aperture`) as the circumcicle diameter, and `%%num_elements` as the number of sides of the polygon. The ratio is used specify the aperture size of each transducer element in the array, as a ratio of the total aperture.
598
598
@@ -678,7 +678,7 @@ Implementation of the parameters into the model follow [Ando (2010)](references.
678
678
679
679
| Parameter | Type | Description |
680
680
| ---: | :----: | :--- |
681
-
|`perturb_flow`| Logical | Perturb the initlal velocity field by random noise |
681
+
|`perturb_flow`| Logical | Perturb the initlial velocity field by random noise |
682
682
|`perturb_flow_fluid`| Integer | Fluid density whose flow is to be perturbed |
683
683
|`perturb_flow_mag`| Real | Set the magnitude of flow perturbations |
684
684
|`perturb_sph`| Logical | Perturb the initial partial density by random noise |
@@ -789,15 +789,15 @@ The entries labeled "Characteristic." are characteristic boundary conditions bas
789
789
| 4 | Sweep line | 2 | Y | Not coordinate aligned. Requires `[x,y]_centroid` and `normal(i)`. |
790
790
| 5 | Ellipse | 2 | Y | Requires `[x,y]_centroid` and `radii(i)`. |
791
791
| 6 | N/A | 2 | N | No longer exists. Empty. |
792
-
| 7 | 2D analytical| 2 | N | Assigns the primitive variables as analytical functions. |
792
+
| 7 | 2D Hardcoded| 2 | N | Assigns the primitive variables as analytical functions. |
793
793
| 8 | Sphere | 3 | Y | Requires `[x,y,z]_centroid` and `radius`|
794
794
| 9 | Cuboid | 3 | N | Coordinate-aligned. Requires `[x,y,z]_centroid` and `length_[x,y,z]`. |
795
795
| 10 | Cylinder | 3 | Y | Requires `[x,y,z]_centroid`, `radius`, and `length_[x,y,z]`. |
796
796
| 11 | Sweep plane | 3 | Y | Not coordinate-aligned. Requires `x[y,z]_centroid` and `normal(i)`. |
797
797
| 12 | Ellipsoid | 3 | Y | Requires `[x,y,z]_centroid` and `radii(i)`. |
798
-
| 13 | 3D analytical| 3 | N | Assigns the primitive variables as analytical functions |
798
+
| 13 | 3D Hardcoded| 3 | N | Assigns the primitive variables as analytical functions |
0 commit comments