PlasmaCalcs.dimensions.fluids.Fluid

class PlasmaCalcs.dimensions.fluids.Fluid(name=None, i=None, *, m=None, q=None)

Bases: DimensionValue

fluid… unchanging properties of the fluid.

name: the name (str) of the fluid. if None, cannot convert to str. i: the index (int) of the fluid (within a FluidList). if None, cannot convert to int.

other inputs should be in “elementary” units, i.e.:

m: mass, in atomic mass units (1 for H+) q: charge, in elementary charge units (1 for H+; -1 for e-)

__init__(name=None, i=None, *, m=None, q=None)

Methods

__init__([name, i, m, q])
copy(**kw_init)
deserialize(serial)
equal_except_i(v)
from_dict(d)
is_charged()
is_electron()
is_ion()
is_neutral()
lookup_dict()
register_type(cls_to_register[, ...])
serialize()
to_dict()
with_i(i)

Attributes

SERIAL_TYPES
name
ndim
size

copy(**kw_init)

return a copy of self. Can provide new kwargs here to override old values in result.

E.g. self.copy(i=7) makes a copy of self but with i=7 instead of self.i.

static deserialize(serial)

creates an XarrayIoSerializable object from a serialized representation.

serial: dict or str

str –> convert to dict via ast.literal_eval.

dict must contain ‘typename’ key.

The output here will be an instance of XarrayIoSerializable.SERIAL_TYPES[typename]

equal_except_i(v)

returns whether self == v (another DimensionValue), ignoring i.

equal if v is an instance of type(self) and

all kw from both self._kw_eq and v._kw_eq have the same values.

(any kw missing attrs will be treated as UNSET.)

For DimensionValue: self.s==v.s and self.i==v.i. Subclasses may add more.

classmethod from_dict(d)

return cls from dict d.

If ‘d’ contains ‘typename’, result is like cls.deserialize(d) instead,

however, first require that result is an instance of cls (or subclass of cls).

E.g. Fluid.from_dict(dict(typename=’EppicDist’, …)) returns EppicDist,

but Snap.from_dict(dict(typename=’EppicDist’, …)) crashes with InputError.

Subclasses wishing to alter deserialize behavior will probably override this method instead.

is_charged()

tells whether self is a charged fluid. i.e. self.q != 0.

if self.q is None, returns None instead of bool.

is_electron()

tells whether self is an electron. i.e. self.q < 0.

if self.q is None, returns None instead of bool.

is_ion()

tells whether self is an ion. i.e. self.q > 0.

if self.q is None, returns None instead of bool.

is_neutral()

tells whether self is a neutral fluid. i.e. self.q == 0.

if self.q is None, returns None instead of bool.

lookup_dict()

returns dict for looking up self within a DimensionValueList, given int, str, or self.

(used by DimensionValueList.lookup_dict)

property name

alias to s

static register_type(cls_to_register, _serial_typename=None)

register cls_to_register as a serializable subclass of XarrayIoSerializable.

_serial_typename: str or None

name to use for serialization. if None, use cls_to_register.__name__.

serialize()

return dict of info about self, including ‘typename’ key.

to_dict()

return dictionary of info about self. Attribute values for keys in self._kw_def.

e.g. if _kw_def={‘s’, ‘i’}: result = {‘s’: self.s, ‘i’: self.i}

with_i(i)

return copy of self with i=i, or self if self.i==i already.