Lionbolt

class Lionbolt(fname)

The Lionbolt class serves to read in Lionbolt data.

Print an object of this class to view all available attributes.

Parameters:

fname (str) – File name corresponding to an HDF5 file output by Lionbolt.

Examples

Load a Lionbolt HDF5 file, work with a particle, then destroy:

>>> D = Lionbolt('results.h5')
>>> el = D.electrons
>>> D.destroy ()

h5

h5py.File object corresponding to the user’s HDF5 file.

Type:

h5py.File

problem_type

Either ‘slab’ or ‘general’ depending on the solve described by this HDF5 file.

Type:

str

mesh

The mesh used in the solve.

Type:

Mesh

XSLib

Cross section library used in the solve.

Type:

XSLibrary

<particle name>

Particle solved, named according to how it was written in the HDF5 file.

Type:

Particle

charge_deposition()

Calculates or fetches (if present) the charge deposition map.

Returns:

dmap – Charge deposition indexed by spatial degree of freedom.

Return type:

np.float64 [:]

destroy()

Deallocates all data

dose_deposition()

Calculates or fetches (if present) the dose deposition map.

Returns:

dmap – Dose deposition indexed by spatial degree of freedom.

Return type:

np.float64 [:]

energy_deposition()

Calculates or fetches (if present) the energy deposition map.

Returns:

dmap – Energy deposition indexed by spatial degree of freedom.

Return type:

np.float64 [:]