armi.bookkeeping.visualization.vtk module

Visualization implementation for VTK files.

Limitations

This version of the VTK file writer comes with a number of limitations and/or aspects that can be improved upon. For instance:

  • Only the Block and Assembly meshes and related parameters are exported to the VTK file. Adding Core data is totally doable, and will be the product of future work. With more considerable effort, arbitrary components may be visualizable!

  • No efforts are made to de-duplicate the vertices in the mesh, so there are more vertices than needed. Some fancy canned algorithms probably exist to do this, and it wouldn’t be too difficult to do here either. Also future work, but probably not super important unless dealing with really big meshes.

class armi.bookkeeping.visualization.vtk.VtkDumper(baseName: str, inputName: str)[source]

Bases: armi.bookkeeping.visualization.dumper.VisFileDumper

Dumper for VTK data.

This handles writing unstructured meshes and associated Block parameter data to VTK files. The context manager keeps track of how many files have been written (one per time node), and creates a group/collection file when finished.

dumpState(r: armi.reactor.reactors.Reactor, includeParams: Optional[Set[str]] = None, excludeParams: Optional[Set[str]] = None)[source]

Dump a reactor to a VTK file.

Parameters
  • r (reactors.Reactor) – The reactor state to visualize

  • includeParams (list of str, optional) – A list of parameter names to include in the viz file. Defaults to all params.

  • excludeParams (list of str, optional) – A list of parameter names to exclude from the output. Defaults to no params.

_abc_impl = <_abc_data object>
armi.bookkeeping.visualization.vtk._collectObjectData(objs: List[armi.reactor.composites.ArmiObject], includeParams: Optional[Set[str]] = None, excludeParams: Optional[Set[str]] = None) → Dict[str, Any][source]