Skip to content

Commit 03fba68

Browse files
authored
Update visualization.md
1 parent 9864ee0 commit 03fba68

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/documentation/visualization.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Flow visualization
22

3-
Post-processed database in Silo-HDF5 format can be visualized and analyzed using Paraview and VisIt.
3+
A post-processed database in Silo-HDF5 format can be visualized and analyzed using Paraview and VisIt.
44
After the post-processing of simulation data (see section [Running](running.md#running-1)), a directory named `silo_hdf5` contains a silo-HDF5 database.
55
Here, `silo_hdf5/` includes a directory named `root/` that contains index files for flow field data at each saved time step.
66

77
### Visualizing with Paraview
88

9-
Paraview is an open source interactive parallel visualization and graphical analysis tool for viewing scientific data.
9+
Paraview is an open-source interactive parallel visualization and graphical analysis tool for viewing scientific data.
1010
Paraview 5.11.0 has been confirmed to work with the MFC databases for some parallel environments.
11-
Nevertheless, installation and configuration of Paraview can be environment-dependent and are left to the user.
11+
Nevertheless, the installation and configuration of Paraview can be environment-dependent and are left to the user.
1212

1313
The user can launch Paraview and open the index files under `/silo_hdf5/root`.
1414
Once the database is loaded, flow field variables contained in the database can be added to the render view.
15-
Further information on using Paraview can be found in the [documentation](https://docs.paraview.org/en/latest/).
15+
Further information on Paraview can be found in its [documentation](https://docs.paraview.org/en/latest/).
1616
The figure below shows the iso-contour of the liquid void fraction (`alpha`) in the database generated by the example case `3D_sphbubcollapse`.
1717

1818
![](../res/paraview.png)
@@ -27,13 +27,13 @@ In Paraview, this coordinate transformation can be accomplished with the followi
2727
1. Apply a `clean to grid` filter to the raw data
2828

2929
2. Apply a `calculator` filter to the cleaned data
30-
- Set the calulators `attribute type` to point data
30+
- Set the calculator `attribute type` to point data
3131
- Check the box for `Coordinate Results`
32-
- Enter the formulat `coordsX*cos(coordsY)*iHat + coordsX*sin(coordsY)*jHat + coordsZ*kHat`
32+
- Enter the formula `coordsX*cos(coordsY)*iHat + coordsX*sin(coordsY)*jHat + coordsZ*kHat`
3333
- click apply
3434

3535
These steps will transform the raw data into cylindrical coordinates.
36-
For many cases, this step will require resizing of the render view window.
36+
For many cases, this step will require resizing the render view window.
3737

3838
## Visualizing with VisIt
3939

@@ -53,9 +53,9 @@ For analysis and processing of the database using VisIt's capability, the user i
5353

5454
## Serial data output
5555

56-
If `parallel_io = F` then MFC will output the conservative variables to a directory `D/`.
56+
If ``parallel_io = 'F'``, MFC will output the conservative variables to a directory `D/`.
5757
If multiple cores are used ($\mathtt{ppn > 1}$), then a separate file is created for each core.
58-
If there is only one coordinate dimension (`n = 0` and `p = 0`), the primitive variables will also be written to `D/`.
58+
If only one coordinate dimension (`n = 0` and `p = 0`) exists, the primitive variables will also be written to `D/`.
5959
The file names correspond to the variables associated with each equation solved by MFC.
6060
They are written at every `t_step_save` time step.
6161
The conservative variables are
@@ -70,7 +70,7 @@ where $N_c$ are the number of components `num_fluids` and $N_d$ is the number of
7070
There are exceptions: if `model_eqns = 3`, then the six-equation model appends these variables with the internal energies of each component.
7171
If there are sub-grid bubbles `bubbles = T`, then the bubble variables are also written.
7272
These depend on the bubble dynamics model used.
73-
If `polytropic = T`, then the conservative variables are appended by
73+
If ``polytropic = 'T'``, then the conservative variables are appended by
7474

7575
$$ n\_b R\_1, n\_b {\\dot R}\_1, \dots, n\_b R\_{N\_b}, n\_b {\\dot R}\_{N\_b} $$
7676

@@ -93,11 +93,11 @@ Place the file `paceParview.zip` in your scratch direction on Phoenix and unzip
9393
Enter the new directory `paceParaview` and run `tar -xvf ParaView-5.11.0-egl-MPI-Linux-Python3.9-x86_64.tar.gz` to decompress the compiled binary.
9494
Now that you have the binary on Phoenix, you must download Paraview 5.11 on your local machine.
9595
Paraview binaries can be downloaded [here](https://www.paraview.org/download/).
96-
Be sure to select `v5.11` from the version drop-down bar and install a `5.11.0` version of Paraview.
96+
Select `v5.11` from the version drop-down bar and install a `5.11.0` version of Paraview.
9797

9898
### Step 2: Customizing the script
9999

100-
While all of the options for the bash script could be passed as command-line arguments, hardcoding certain unlikely-to-change options saves time.
100+
While all of the bash script's options could be passed as command-line arguments, hardcoding certain unlikely-to-change options saves time.
101101
The following is a list of required and suggested updates to make to `pace-paraview-server`.
102102

103103
- (Optional) Update line 4 to customize the job name that will show up in the scheduler
@@ -111,7 +111,7 @@ Before running `pace-paraview-server` for the first time, you must update its pe
111111
Once this has been done, you can run `./pace-paraview-server` with the following options:
112112

113113
- `--account` specifies the charge account for the job.
114-
If you updated line 51 of `pace-paraview-server` to reflect a default account, this option is optional, otherwise it is required.
114+
If you updated line 51 of `pace-paraview-server` to reflect a default account, this option is optional; otherwise, it is required.
115115
- `--nodes` specifies the number of nodes to request (default 1)
116116
- `--mem` specifies the memory per node to request (default is to request all memory)
117117
- `--gres` specifies the GPU resources to request.
@@ -136,7 +136,7 @@ Below is a slightly altered version of that dialogue:
136136
* `ssh -L 8722:<nodeIdentifier>:53723 <paceSystemIdentifier>`
137137

138138
2) Once you have `Paraview5.11.0` on your machine, select `File -> Connect..` to open the remote connection dialogue box.
139-
* If you've already set up the pace connection, simply double-click the existing configuration.
139+
* Double-click the existing configuration if you've already set up the pace connection.
140140
* Click `Add Server` If you have not set up the PACE connection.
141141
This will create a new dialogue box where you can specify a configuration name and set the `Port` to `8722`.
142142
Once this is done, click `configure` and then `save` on the next dialogue box.

0 commit comments

Comments
 (0)