Skip to content

Commit 810af5c

Browse files
committed
documentation updates
1 parent 70ec0f4 commit 810af5c

File tree

3 files changed

+54
-8
lines changed

3 files changed

+54
-8
lines changed

docs/documentation/case.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,6 @@ If `file_per_process` is true, then pre_process, simulation, and post_process mu
530530

531531
- `probe_wrt` activates output of state variables at coordinates specified by `probe(i)%[x;y,z]`.
532532

533-
534533
### 8. Acoustic Source {#acoustic-source}
535534

536535
| Parameter | Type | Description |
@@ -756,6 +755,22 @@ $$ a_{x[y,z]} = g_{x[y,z]} + k_{x[y,z]}\sin\left(w_{x[y,z]}t + p_{x[y,z]}\right)
756755

757756
Positive accelerations are in the `x[y,z]` direction are in the positive `x[y,z]` direction by convention.
758757

758+
### 14. Cylindrical Coordinates
759+
760+
When `cyl_coord = 'T'` is set in 3D the following constraints must be met:
761+
762+
- `bc_y%beg = -14` to enable to axis boundary condition
763+
764+
- `bc_z%beg = bc_z%end = -1` to enable periodic boundary conditions in the azimuthal direction
765+
766+
- `z_domain%beg = 0` to set the azithmuthal starting point to 0
767+
768+
- `z_comain%end = 2*math.pi` to set the azithmuthal ending point to $2\pi$ (note, requires `import math` in the case file)
769+
770+
When `cyl_coord = 'T'` is set in 2D the following constraints must be met:
771+
772+
- `bc_y%beg = -2` to enable reflective boundary conditions
773+
759774
## Enumerations
760775

761776
### Boundary conditions

docs/documentation/visualization.md

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

3-
Post-processed database in Silo-HDF5 format can be visualized and analyzed using VisIt.
4-
VisIt is an open-source interactive parallel visualization and graphical analysis tool for viewing scientific data.
3+
Post-processed database in Silo-HDF5 format can be visualized and analyzed using Paraview and VisIt.
4+
After the post-processing of simulation data (see section [Running](running.md#running-1)), a directory named `silo_hdf5` contains a silo-HDF5 database.
5+
Here, `silo_hdf5/` includes a directory named `root/` that contains index files for flow field data at each saved time step.
6+
7+
### Visualizing with Paraview
8+
9+
Paraview is an open source interactive parallel visualization and graphical analysis tool for viewing scientific data.
10+
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.
12+
13+
The user can launch Paraview and open the index files under `/silo_hdf5/root`.
14+
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/).
16+
The figure below shows the iso-contour of the liquid void fraction (`alpha`) in the database generated by the example case `3D_sphbubcollapse`.
17+
18+
![](../res/paraview.png)
19+
20+
*Iso-contour of the liquid void fraction (`alpha1`) in the database generated by example case `3D_sphbubcollapse`*
21+
22+
### Visualizing data in cylindrical coordinates
23+
24+
Visualizing data in cylindrical coordinates requires a coordinate transformation of the raw data in the database file.
25+
In Paraview, this coordinate transformation can be accomplished with the following steps:
26+
27+
1. Apply a `clean to grid` filter to the raw data
28+
29+
2. Apply a `calculator` filter to the cleaned data
30+
- Set the calulators `attribute type` to point data
31+
- Check the box for `Coordinate Results`
32+
- Enter the formulat `coordsX*cos(coordsY)*iHat + coordsX*sin(coordsY)*jHat + coordsZ*kHat`
33+
- click apply
34+
35+
These steps will transform the raw data into cylindrical coordinates.
36+
For many cases, this step will require resizing of the render view window.
37+
38+
## Visualizing with VisIt
39+
40+
VisIt is an alternative open-source interactive parallel visualization and graphical analysis tool for viewing scientific data.
541
Versions of VisIt after 2.6.0 have been confirmed to work with the MFC databases for some parallel environments.
642
Nevertheless, installation and configuration of VisIt can be environment-dependent and are left to the user.
743
Further remarks on parallel flow visualization, analysis, and processing of the MFC database using VisIt can also be found in [Coralic (2015)](references.md#Coralic15) and [Meng (2016)](references.md#Meng16).
844

9-
## Procedure
10-
11-
After the post-processing of simulation data (see section [Running](running.md#running-1)), a directory named `silo_hdf5` contains a silo-HDF5 database.
12-
Here, `silo_hdf5/` includes a directory named `root/` that contains index files for flow field data at each saved time step.
1345
The user can launch VisIt and open the index files under `/silo_hdf5/root`.
1446
Once the database is loaded, flow field variables contained in the database can be added to the plot.
15-
1647
The figure below shows the iso-contour of the liquid void fraction (`alpha1`) in the database generated by the example case `3D_sphbubcollapse`.
1748
For analysis and processing of the database using VisIt's capability, the user is encouraged to address [VisIt user manual](https://wci.llnl.gov/simulation/computer-codes/visit/manuals).
1849

docs/res/paraview.png

312 KB
Loading

0 commit comments

Comments
 (0)