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.
	write_oft_xml (xml_blocks, path, pretty=True)
	Write OFT XML file from a list of XML block objects.

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

path	Folder to build XDMF files in (must include oft_xdmf.XXXX.h5 or dump.dat files)
repeat_static	Repeat static fields (0-th timestep) in all timesteps?
pretty	Use pretty printing (indentation) in XDMF files?
legacy	Use legacy XDMF script for processing dump.dat files?

write_oft_xml()

write_oft_xml	(		xml_blocks,
			path,
			pretty = True )

Write OFT XML file from a list of XML block objects.

Parameters

xml_blocks	List of objects for child nodes, must implement build_XML method
path	Output path for XML file
pretty	Whether to pretty-print the XML with indentation (default: True)

Variable Documentation

eol_byte

str eol_byte = '\n'.encode()