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
- † Options that work only with ``cyl_coord = 'F'``.
@@ -447,37 +447,37 @@ If this option is false, velocity gradient is computed using finite difference s
447
447
-`weno_avg` it activates the arithmetic average of the left and right, WENO-reconstructed, cell-boundary values.
448
448
This option requires `weno_Re_flux` to be true because cell boundary values are only utilized when employing the scalar divergence method in the computation of velocity gradients.
449
449
450
-
-`surface_tension` activates surface tension when set to `'T'`. Requires `sigma` to be set.
450
+
-`surface_tension` activates surface tension when set to ``'T'``. Requires `sigma` to be set.
451
451
452
-
-`viscous` activates viscosity when set to `'T'`. Requires `Re(1)` and `Re(2)` to be set.
452
+
-`viscous` activates viscosity when set to ``'T'``. Requires `Re(1)` and `Re(2)` to be set.
453
453
454
454
#### Constant Time-Stepping
455
455
456
-
-`dt` specifies the constant time step size that is used in simulation.
457
-
The value of `dt` needs to be sufficiently small such that the Courant-Friedrichs-Lewy (CFL) condition is satisfied.
456
+
-`dt` specifies the constant time step size used in the simulation.
457
+
The value of `dt` needs to be sufficiently small to satisfy the Courant-Friedrichs-Lewy (CFL) condition.
458
458
459
-
-`t_step_start` and `t_step_end` define the time steps at which simulation starts and ends, respectively.
459
+
-`t_step_start` and `t_step_end` define the time steps at which the simulation starts and ends.
460
460
461
461
`t_step_save` is the time step interval for data output during simulation.
462
462
To newly start the simulation, set `t_step_start = 0`.
463
-
To restart simulation from $k$-th time step, set `t_step_start = k`, see [Restarting Cases](running.md#restarting-cases).
463
+
To restart the simulation from $k$-th time step, set `t_step_start = k`; see [Restarting Cases](running.md#restarting-cases).
464
464
465
465
##### Adaptive Time-Stepping
466
466
467
467
-`cfl_adap_dt` enables adaptive time stepping with a constant CFL when true
468
468
469
-
-`cfl_const_dt` enables constant dt time-stepping where dt results in a specified CFL for the initial condition
469
+
-`cfl_const_dt` enables constant `dt` time-stepping where `dt` results in a specified CFL for the initial condition
470
470
471
471
-`cfl_target` specifies the target CFL value
472
472
473
473
-`n_start` specifies the save file to start at
474
474
475
-
-`t_save` specifies the time interval between data output during simulation
475
+
-`t_save` specifies the time interval between data output during the simulation
476
476
477
477
-`t_stop` specifies at what time the simulation should stop
478
478
479
479
To newly start the simulation, set `n_start = 0`.
480
-
To restart simulation from $k$-th time step, see [Restarting Cases](running.md#restarting-cases).
480
+
To restart the simulation from $k$-th time step, see [Restarting Cases](running.md#restarting-cases).
481
481
482
482
### 7. Formatted Output
483
483
@@ -518,23 +518,23 @@ The table lists formatted database output parameters. The parameters define vari
518
518
519
519
-`parallel_io` activates parallel input/output (I/O) of data files. It is highly recommended to activate this option in a parallel environment.
520
520
With parallel I/O, MFC inputs and outputs a single file throughout pre-process, simulation, and post-process, regardless of the number of processors used.
521
-
Parallel I/O enables the use of different number of processors in each of the processes (i.e., simulation data generated using 1000 processors can be post-processed using a single processor).
521
+
Parallel I/O enables the use of different numbers of processors in each process (e.g., simulation data generated using 1000 processors can be post-processed using a single processor).
522
522
523
523
-`file_per_process` deactivates shared file MPI-IO and activates file per process MPI-IO.
524
524
The default behavior is to use a shared file.
525
-
File per process is useful when running on 10's of thousands of ranks.
525
+
File per process is useful when running on >10K ranks.
526
526
If `file_per_process` is true, then pre_process, simulation, and post_process must be run with the same number of ranks.
527
527
528
-
-`cons_vars_wrt` and `prim_vars_wrt` activate output of conservative and primitive state variables into the database, respectively.
528
+
-`cons_vars_wrt` and `prim_vars_wrt` activate the output of conservative and primitive state variables into the database.
529
529
530
-
-`[variable's name]_wrt` activates output of the each specified variable into the database.
530
+
-`[variable's name]_wrt` activates the output of each specified variable into the database.
531
531
532
532
-`schlieren_alpha(i)` specifies the intensity of the numerical Schlieren of $i$-th component.
533
533
534
-
-`fd_order` specifies the order of the finite difference scheme that is used to compute the vorticity from the velocity field and the numerical schlieren from the density field by an integer of 1, 2, and 4.
535
-
`fd_order = 1`, `2`, and `4` correspond to the first, second, and fourth-order finite difference schemes, respectively.
534
+
-`fd_order` specifies the order of the finite difference scheme used to compute the vorticity from the velocity field and the numerical schlieren from the density field using an integer of 1, 2, and 4.
535
+
`fd_order = 1`, `2`, and `4` correspond to the first, second, and fourth-order finite difference schemes.
536
536
537
-
-`probe_wrt` activates output of state variables at coordinates specified by `probe(i)%[x;y,z]`.
537
+
-`probe_wrt` activates the output of state variables at coordinates specified by `probe(i)%[x;y,z]`.
538
538
539
539
540
540
### 8. Acoustic Source {#acoustic-source}
@@ -597,15 +597,15 @@ Details of the transducer acoustic source model can be found in [Maeda and Colon
597
597
598
598
-`%%foc_length` specifies the focal length of the transducer for transducer waves. It is the distance from the transducer to the focal point.
599
599
600
-
-`%%aperture` specifies the aperture of the transducer. It is the diameter of the projection of the transducer arc onto the y-axis (2D) or spherical cap onto the y-z plane (3D). To simulate a transducer enclosing half of the circle/sphere, set the aperture to double the focal length. For transducer array, it is the total aperture of the array.
600
+
-`%%aperture` specifies the aperture of the transducer. It is the diameter of the projection of the transducer arc onto the y-axis (2D) or spherical cap onto the y-z plane (3D). Set the aperture to double the focal length to simulate a transducer enclosing half of the circle/sphere. For the transducer array, it is the total aperture of the array.
601
601
602
602
-`%%num_elements` specifies the number of transducer elements in a transducer array.
603
603
604
-
-`%%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.
604
+
-`%%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.
605
605
606
-
-`%%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.
606
+
-`%%element_spacing_angle` specifies the spacing angle between adjacent transducers in radians. The total aperture (`%%aperture`) is set, so each transducer element is smaller if `%%element_spacing_angle` is larger.
607
607
608
-
-`%%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.
608
+
-`%%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 circumcircle diameter and `%%num_elements` as the number of sides of the polygon. The ratio is used to specify the aperture size of each transducer element in the array as a ratio of the total aperture.
609
609
610
610
-`%%rotate_angle` specifies the rotation angle of the 3D circular transducer array along the x-axis (principal axis). It is optional and defaults to 0.
611
611
@@ -633,16 +633,16 @@ Details of the transducer acoustic source model can be found in [Maeda and Colon
633
633
|`mu_v` † | Real | Viscosity |
634
634
|`k_v` † | Real | Thermal conductivity |
635
635
|`qbmm`| Logical | Quadrature by method of moments|
636
-
|`dist_type`| Integer | Joint probability density function for bubble radius and velocity (only when qbmm is true)|
637
-
|`sigR`| Real | Standard deviation for probability density function of bubble radius (only when qbmm is true) |
638
-
|`sigV`| Real | Standard deviation for probability density function of bubble velocity (only when qbmm is true) |
639
-
|`rhoRV`| Real | Correlation coefficient for joint probability density function of bubble radius and velocity (only when qbmm is true) |
636
+
|`dist_type`| Integer | Joint probability density function for bubble radius and velocity (only for ``qbmm = 'T'``)|
637
+
|`sigR`| Real | Standard deviation for the probability density function of bubble radius (only for ``qbmm = 'T'``) |
638
+
|`sigV`| Real | Standard deviation for the probability density function of bubble velocity (only for ``qbmm = 'T'``) |
639
+
|`rhoRV`| Real | Correlation coefficient for the joint probability density function of bubble radius and velocity (only for ``qbmm = 'T'``) |
640
640
641
-
These options work only for gas-liquid twocomponent flows.
641
+
These options work only for gas-liquid two-component flows.
642
642
Component indexes are required to be 1 for liquid and 2 for gas.
643
643
644
-
-\* These parameters should be pretended with patch index $1$ that is filled with liquid: `fluid_pp(1)%`.
645
-
- † These parameters should be pretended with patch indexes that are respectively filled with liquid and gas: `fluid_pp(1)%` and `fluid_pp(2)%`.
644
+
-\* These parameters should be prepended with patch index $1$ that is filled with liquid: `fluid_pp(1)%`.
645
+
- † These parameters should be prepended with patch indexes filled with liquid and gas: `fluid_pp(1)%` and `fluid_pp(2)%`.
646
646
647
647
This table lists the ensemble-averaged bubble model parameters.
648
648
@@ -652,9 +652,9 @@ This table lists the ensemble-averaged bubble model parameters.
652
652
`bubble_model = 1`, `2`, and `3` correspond to the Gilmore, Keller-Miksis, and Rayleigh-Plesset models.
653
653
654
654
-`polytropic` activates polytropic gas compression in the bubble.
655
-
When `polytropic` is set `False`, the gas compression is modeled as non-polytropic due to heat and mass transfer across the bubble wall with constant heat and mass transfer coefficients based on ([Preston et al., 2007](references.md#Preston07)).
655
+
When ``polytropic = 'F'``, the gas compression is modeled as non-polytropic due to heat and mass transfer across the bubble wall with constant heat and mass transfer coefficients based on ([Preston et al., 2007](references.md#Preston07)).
656
656
657
-
-`polydisperse` activates polydispersity in the bubble model by means of a probability density function (PDF) of the equiliibrium bubble radius.
657
+
-`polydisperse` activates polydispersity in the bubble model through a probability density function (PDF) of the equilibrium bubble radius.
658
658
659
659
-`thermal` specifies a model for heat transfer across the bubble interface by an integer from 1 through 3.
660
660
`thermal = 1`, `2`, and `3` correspond to no heat transfer (adiabatic gas compression), isothermal heat transfer, and heat transfer with a constant heat transfer coefficient based on [Preston et al., 2007](references.md#Preston07), respectively.
@@ -679,17 +679,17 @@ Implementation of the parameters into the model follow [Ando (2010)](references.
679
679
680
680
-`dist_type` specifies the initial joint PDF of initial bubble radius and bubble velocity required in qbmm. `dist_type = 1` and `2` correspond to binormal and lognormal-normal distributions respectively.
681
681
682
-
-`sigR` specifies the standard deviation of the PDF of bubble radius required in qbmm.
682
+
-`sigR` specifies the standard deviation of the PDF of bubble radius required in the QBMM feature.
683
683
684
-
-`sigV` specifies the standard deviation of the PDF of bubble velocity required in qbmm.
684
+
-`sigV` specifies the standard deviation of the PDF of bubble velocity required in the QBMM feature.
685
685
686
-
-`rhoRV` specifies the correlation coefficient of the joint PDF of bubble radius and bubble velocity required in qbmm.
686
+
-`rhoRV` specifies the correlation coefficient of the joint PDF of bubble radius and bubble velocity required in the QBMM feature.
687
687
688
688
### 10. Velocity Field Setup
689
689
690
690
| Parameter | Type | Description |
691
691
| ---: | :----: | :--- |
692
-
|`perturb_flow`| Logical | Perturb the initlial velocity field by random noise |
692
+
|`perturb_flow`| Logical | Perturb the initial velocity field by random noise |
693
693
|`perturb_flow_fluid`| Integer | Fluid density whose flow is to be perturbed |
694
694
|`perturb_flow_mag`| Real | Set the magnitude of flow perturbations |
695
695
|`perturb_sph`| Logical | Perturb the initial partial density by random noise |
@@ -704,15 +704,15 @@ The parameters are optionally used to define initial velocity profiles and pertu
704
704
705
705
-`perturb_flow` activates the perturbation of initial velocity by random noise.
706
706
707
-
-`perturb_flow_fluid` specifies the fluid component whose flow is to be perturbed.
707
+
-`perturb_flow_fluid` specifies the fluid component whose flow will be perturbed.
708
708
709
709
-`perturb_flow` activates the perturbation of initial velocity by random noise.
710
710
711
711
-`perturb_sph` activates the perturbation of initial partial density by random noise.
712
712
713
713
-`perturb_sph_fluid` specifies the fluid component whose partial density is to be perturbed.
714
714
715
-
-`mixlayer_vel_profile` activates setting of the mean streamwise velocity to hyperbolic tangent profile. This option works only for 2D and 3D cases.
715
+
-`mixlayer_vel_profile` activates setting the mean streamwise velocity to a hyperbolic tangent profile. This option works only for 2D and 3D cases.
716
716
717
717
-`mixlayer_vel_coef` is a parameter for the hyperbolic tangent profile of a mixing layer when `mixlayer_vel_profile = 'T'`. The mean streamwise velocity profile is given as:
0 commit comments