PlasmaCalcs.dimensions.dimension_tools.dim_point.DimPoint

class PlasmaCalcs.dimensions.dimension_tools.dim_point.DimPoint(*args_dict, **kw_dict)

Bases: DimRegion

dict of values representing a single point in dimension-space.

When setting elements of this dict, ensures not is_iterable_dim(value)

Does not need to include all dimensions, but all contents must be single-valued dimensions.

E.g. {‘fluid’: 0, ‘snap’: 1} is fine, even if ‘jfluid’ and ‘component’ are also dimensions.

However, {‘fluid’: 0, ‘component’:[0,1,2]} is not, because component is multi-valued.

__init__(*args_dict, **kw_dict)

Methods

__init__(*args_dict, **kw_dict)
assign_to(array, **kw_xarray_assign)
clear()
copy()
fromkeys([value])
get(key[, default])
items()
keys()
pop(k[,d])
popitem()
setdefault(key[, default])
update([E, ]**F)
values()

assign_to(array, **kw_xarray_assign)

array.assign_coords(self). Internally, use PlasmaCalcs xarray_assign function.

xarray_assign also allows to provide attrs and/or name to assign those as well.

Also convert array to xr.DataArray if it isn’t one already.

Probably will fail if any values are iterable dimensions e.g. DimensionValueList instead of DimensionValue.

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, default is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order.

Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]

If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v

In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values