Skip to content

Commit

Permalink
Address comments from the PR.
Browse files Browse the repository at this point in the history
  • Loading branch information
alarshi committed Jan 30, 2025
1 parent fab832e commit d207005
Showing 1 changed file with 5 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
Visualization Grid file
=======================

```{todo}
This part of the manual is used to list all the parameters for the visualization grid file.
```

The visualization grid file is used to create a structured mesh and populate the node points with the generated world, i.e., initial conditions of temperature, composition, grains, etc. In essence, it is a text file that contains 3 major sections specifying the mesh points and values :

1. Mesh Output Type
Expand All @@ -18,17 +14,17 @@ The dimensions of the world.
* compositions = 0
The number of compositions the output .vtu file contains. It can be any number from 0 to MAX_UNSIGNED_INT value. This means that even if we only have 1 composition in the input `.wb` file, it is possible to create visualization outputs for many compositional fields, which will be just equal to zero everywhere in the output mesh. If no value is specified, then it is assumed that there are no compositional fields, i.e., `compositions = 0`.

2. Mesh extent
The following lines specify the domain of the grid. In case of 2D, you only need to specify the x and the z extent. Each of the following variables can be a double with a value from -MAX_DOUBLE to MAX_DOUBLE (inclusive)
2. Mesh Extent
The following lines specify the domain of the grid. In case of 2D, you only need to specify the x and the z extents. Each of the following variables can be a double with a value from -MAX_DOUBLE to MAX_DOUBLE (inclusive). For the spherical coordinate system, the same variable names (as mentioned below) are used, where `x_{min|max}, y_{min|max}, z_{min|max}` represent the extent in the longitude, latitude, and radial directions, respectively.
* x_min
* x_max
* y _min
* y_min
* y_max
* z_min
* z_max

3. Mesh discretization
Along with the domain extent, we also need to specify the number of points along each direction (for a 2D cross-section of world, only specify in the X and Z directions). The following variables will do exactly that and can have any value from 1 to the MAX_INT (inclusive).
3. Mesh Discretization
Along with the domain extent, we also need to specify the number of points along each direction (for a 2D cross-section of world, only specify in the x and z directions). The following variables will do exactly that and can have any value from 1 to the MAX_INT (inclusive). For spherical coordinate system, the same variable names are used, where `n_cell_x, n_cell_y, n_cell_z` represent the discretization in the longitude, latitude, and radial directions, respectively.
* n_cell_x
* n_cell_y
* n_cell_z
Expand Down

0 comments on commit d207005

Please sign in to comment.