PlasmaCalcs.hookups.bifrost.bifrost_io_tools.BifrostVarPathsManager

class PlasmaCalcs.hookups.bifrost.bifrost_io_tools.BifrostVarPathsManager(snap, bcalc)

Bases: object

manages filepaths (as abspaths) and readable vars for a BifrostSnap.
self.kind2path = {kind: path}
self.kind2vars = {kind: [list of readable vars]}
self.var2kind = {var: kind}
self.var2path = {var: path}
self.path2kind = {path: kind}
self.path2vars = {path: [list of readable vars]}
self.var2index = {var: index of var in its path’s list of vars}

self.kinds: tuple of kinds with any vars in self.
self.vars: tuple of all vars in self.
self.paths: tuple of all paths with any vars in self.

kinds are: ‘snap’, ‘aux’, ‘hion’, ‘helium’, ‘ooe’.

if kind has no vars, do not include it in results.

snap: BifrostSnap bcalc: BifrostCalculator

__init__(snap, bcalc)

Methods

`__init__`(snap, bcalc)
`help`()
`init_all`()
`init_aux_kind`()
`init_helium_kind`()
`init_hion_kind`()
`init_ooe_kind`()
`init_snap_kind`()
`kind2filebase`(kind)
`snappath`(filename)

Attributes

`KIND2FILEBASE`
`KINDS`
`NNN`
`bcalc`
`params`
`snap`
`snapdir`
`snapname`

property NNN: (str) the NNN part of the snapname_NNN.idl filename.

property bcalc: gets self._bcalc(), or just self._bcalc if not self._bcalc_is_weakref.

help(): print docstring of self…

init_all(): init all KINDS in self.

init_aux_kind(): vars stored in snapname_NNN.aux file.

init_helium_kind(): vars stored in snapname.helium_NNN.snap file.

init_hion_kind(): vars stored in snapname.hion_NNN.snap file.

init_ooe_kind(): out of equilibrium vars.

init_snap_kind(): vars stored in snapname_NNN.snap file.

kind2filebase(kind): returns file basename for this kind.

Equivalent: self.KIND2FILEBASE[kind].format(snapname=self.snapname, NNN=self.NNN)

property params: alias to self.snap.params

property snap: gets self._snap(), or just self._snap if not self._snap_is_weakref.

property snapdir: alias to self.bcalc.snapdir

property snapname: alias to self.params[‘snapname’]

snappath(filename): returns os.path.join(self.snapdir, filename)