The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Classes | Functions | Variables
OpenFUSIONToolkit.io Namespace Reference

Detailed Description

General I/O functionality for Open FUSION Toolkit (OFT) Python interfaces.

Authors
Chris Hansen
Date
July 2024

Classes

class  histfile
 Class for loading and analyzing a structured OFT binary file. More...
 
class  XDMF_plot_file
 Helper class for interacting with OFT plotting output files. More...
 
class  XDMF_plot_mesh
 Class containing data for a single mesh from OFT plot files. More...
 

Functions

 build_XDMF (path='.', repeat_static=False, pretty=False, legacy=False)
 Build XDMF plot metadata files.
 

Variables

str eol_byte = '\n'.encode()
 

Function Documentation

◆ build_XDMF()

build_XDMF (   path = '.',
  repeat_static = False,
  pretty = False,
  legacy = False 
)

Build XDMF plot metadata files.

Parameters
pathFolder to build XDMF files in (must include oft_xdmf.XXXX.h5 or dump.dat files)
repeat_staticRepeat static fields (0-th timestep) in all timesteps?
prettyUse pretty printing (indentation) in XDMF files?
legacyUse legacy XDMF script for processing dump.dat files?

Variable Documentation

◆ eol_byte

str eol_byte = '\n'.encode()