tardis.plasma.base module

class tardis.plasma.base.BasePlasma(*args, **kwargs)

Bases: PlasmaWriterMixin

freeze(*args)

Freeze plama properties.

This method freezes plasma properties to prevent them from being updated: the values of a frozen property are fixed in the plasma calculation. This is useful for example for setting up test cases.

Parameters

argsiterable of str

Names of plasma properties to freeze.

Examples

>>> plasma.freeze('t_electrons')

get_value(item)

hdf_name = 'plasma'

outputs_dict = {}

property plasma_properties_dict

remove_hidden_properties(print_graph)

store_previous_properties()

thaw(*args)

Thaw plama properties.

This method thaws (unfreezes) plasma properties allowing them to be updated again.

Parameters

argsiterable of str

Names of plasma properties to unfreeze.

Examples

>>> plasma.thaw('t_electrons')

update(**kwargs)

write_to_dot(fname, args=None, latex_label=True)

This method takes the NetworkX Graph generated from the _build_graph method, converts it into a DOT code, and saves it to a file

Parameters

fname: str

the name of the file the graph will be saved to

args: list

a list of optional settings for displaying the graph written in DOT format

latex_label: boolean

enables/disables writing LaTeX equations and edge labels into the file.

write_to_tex(fname_graph, scale=0.5, args=None, latex_label=True)

This method takes the NetworkX Graph generated from the _build_graph method, converts it into a LaTeX friendly format, and saves it to a file

Parameters

fname_graph: str

the name of the file the graph will be saved to

args: list

a list of optional settings for displaying the graph written in DOT format

scale: float

a scaling factor to expand/contract the generated graph

latex_label: boolean

enables/disables writing LaTeX equations and edge labels into the file.