The Open FUSION Toolkit 1.0.0-beta6
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
XDMF_plot_file Class Reference

Detailed Description

Helper class for interacting with OFT plotting output files.

Public Member Functions

 __getitem__ (self, key)
 __init__ (self, filepath)
 Load data from file and setup object.
 __iter__ (self)
 get (self, keyname, value=None)
 Get plotting group (list of meshes).
 items (self)
 Return iterator over plotting group (name, value) pairs.
 keys (self)
 Get plotting groups in file.

Public Attributes

 filepath = filepath

Protected Attributes

dict _groups = {}

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
filepath )

Load data from file and setup object.

Parameters
filenamePath to HDF5 plotting file

Member Function Documentation

◆ __getitem__()

__getitem__ ( self,
key )

◆ __iter__()

__iter__ ( self)

◆ get()

get ( self,
keyname,
value = None )

Get plotting group (list of meshes).

Parameters
keynameName of group
valueReturn value if not found

◆ items()

items ( self)

Return iterator over plotting group (name, value) pairs.

◆ keys()

keys ( self)

Get plotting groups in file.

Member Data Documentation

◆ _groups

_groups = {}
protected

◆ filepath

filepath = filepath

The documentation for this class was generated from the following file: