Skip to content

Commit

Permalink
updated docs with VTK writer updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kip-hart committed Jul 4, 2020
1 parent 34c1605 commit 812fc8b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/source/cli/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,11 @@ Below is an outline of the possible filetypes for each subfield.

- seeds

**txt**
**txt**, **vtk**

Currently the only option is to output the seed geometries as a
cache txt file.
Currently the only options are to output the seed geometries as a
cache txt file or as a VTK legacy file. The VTK file can be opened
in ParaView, with the seeds shown as glyphs.

- seeds_plot

Expand All @@ -105,15 +106,16 @@ Below is an outline of the possible filetypes for each subfield.

- poly

**txt**, **poly** (2D only), **ply**, **vtk** (3D only)
**txt**, **poly** (2D only), **ply**, **vtk**

A poly file contains a planar straight line graph (PSLG) and cane be read
by Triangle.
More details on poly files can be found on the `.poly files`_ page of the
Triangle website.
The ply file contains the surfaces between grains and the boundary of the
domain.
VTK legacy files also contain the polygonal surfaces between grains.
VTK legacy files also contain the polygonal grains in 2D and polyhedral
grains in 3D.

- poly_plot

Expand Down Expand Up @@ -445,4 +447,4 @@ will plot the mesh with thin, white lines between the elements.


.. _`Choosing Colormaps in Matplotlib`: https://matplotlib.org/3.1.0/tutorials/colors/colormaps.html
.. _`.poly files`: https://www.cs.cmu.edu/~quake/triangle.poly.html
.. _`.poly files`: https://www.cs.cmu.edu/~quake/triangle.poly.html

0 comments on commit 812fc8b

Please sign in to comment.