yt.frontends.gizmo.fields module

class yt.frontends.gizmo.fields.GizmoFieldInfo(*args, **kwargs)[source]

Bases: GadgetFieldInfo

add_deprecated_field(name, function, sampling_type, since, removal=None, ret_name=None, **kwargs)

Add a new field which is deprecated, along with supplemental metadata, to the list of available fields. This respects a number of arguments, all of which are passed on to the constructor for DerivedField.

Parameters:

  • name (str) – is the name of the field.

  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)

  • sampling_type (str) – “cell” or “particle” or “local”

  • since (str) – The version string marking when this field was deprecated.

  • removal (str) – The version string marking when this field will be removed.

  • ret_name (str) – The name of the field which will actually be returned, used only by alias().

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • take_log (bool) – Describes whether the field should be logged

  • validators (list) – A list of FieldValidator objects

  • vector_field (bool) – Describes the dimensionality of the field. Currently unused.

  • display_name (str) – A name used in the plots

add_field(name: tuple[str, str], function: Callable, sampling_type: str, *, alias: DerivedField | None = None, force_override: bool = False, **kwargs) → None

Add a new field, along with supplemental metadata, to the list of available fields. This respects a number of arguments, all of which are passed on to the constructor for DerivedField.

Parameters:

  • name (tuple[str, str]) – field (or particle) type, field name

  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)

  • sampling_type (str) – “cell” or “particle” or “local”

  • force_override (bool) – If False (default), an error will be raised if a field of the same name already exists.

  • alias (DerivedField (optional):) – existing field to be aliased

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • take_log (bool) – Describes whether the field should be logged

  • validators (list) – A list of FieldValidator objects

  • vector_field (bool) – Describes the dimensionality of the field. Currently unused.

  • display_name (str) – A name used in the plots

add_output_field(name, sampling_type, **kwargs)
alias(alias_name: tuple[str, str], original_name: tuple[str, str], units: str | None = None, deprecate: tuple[str, str | None] | None = None)

Alias one field to another field.

Parameters:

  • alias_name (tuple[str, str]) – The new field name.

  • original_name (tuple[str, str]) – The field to be aliased.

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • deprecate (tuple[str, str | None] | None) – If this is set, then the tuple contains two string version numbers: the first marking the version when the field was deprecated, and the second marking when the field will be removed.

check_derived_fields(fields_to_check=None)
clear() → None.  Remove all items from D.
copy()
classmethod create_with_fallback(fallback, name='')
property curvilinear: bool
extra_union_fields: tuple[FieldKey, ...] = ()
fallback = None
find_dependencies(loaded)
classmethod fromkeys(iterable, value=None)
get(k[, d]) → D[k] if k in D, else d.  d defaults to None.
has_key(key)
items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
known_other_fields: KnownFieldsT = ()
known_particle_fields: tuple[tuple[str, tuple[str, list[str], str | None]], ...] = (('Coordinates', ('code_length', ['particle_position'], None)), ('Velocities', ('code_velocity', ['particle_velocity'], None)), ('ParticleIDs', ('', ['particle_index'], None)), ('Masses', ('code_mass', ['particle_mass'], None)), ('InternalEnergy', ('code_specific_energy', ['specific_thermal_energy'], None)), ('Density', ('code_mass / code_length**3', ['density'], None)), ('SmoothingLength', ('code_length', ['smoothing_length'], None)), ('ElectronAbundance', ('', [], None)), ('NeutralHydrogenAbundance', ('', [], None)), ('StarFormationRate', ('Msun / yr', ['star_formation_rate'], None)), ('Metallicity', ('code_metallicity', ['metallicity'], None)), ('Metallicity_00', ('', ['metallicity'], None)), ('Metallicity_01', ('', ['He_metallicity'], None)), ('Metallicity_02', ('', ['C_metallicity'], None)), ('Metallicity_03', ('', ['N_metallicity'], None)), ('Metallicity_04', ('', ['O_metallicity'], None)), ('Metallicity_05', ('', ['Ne_metallicity'], None)), ('Metallicity_06', ('', ['Mg_metallicity'], None)), ('Metallicity_07', ('', ['Si_metallicity'], None)), ('Metallicity_08', ('', ['S_metallicity'], None)), ('Metallicity_09', ('', ['Ca_metallicity'], None)), ('Metallicity_10', ('', ['Fe_metallicity'], None)), ('ArtificialViscosity', ('', [], None)), ('MagneticField', ('code_magnetic', ['particle_magnetic_field'], None)), ('DivergenceOfMagneticField', ('code_magnetic / code_length', [], None)), ('StellarFormationTime', ('', [], None)), ('BH_Mass', ('code_mass', [], None)), ('BH_Mdot', ('code_mass / code_time', [], None)), ('BH_Mass_AlphaDisk', ('code_mass', [], None)))
load_all_plugins(ftype: str | None = 'gas') → None
load_plugin(plugin_name: str, ftype: str = 'gas', skip_check: bool = False)
pop(k[, d]) → v, remove specified key and return the corresponding value.

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

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
setup_extra_union_fields(ptype='all')
setup_fluid_aliases(ftype: str = 'gas') → None
setup_fluid_fields()
setup_fluid_index_fields()
setup_gas_particle_fields(ptype)[source]
setup_particle_fields(ptype)[source]
setup_smoothed_fields(ptype, num_neighbors=64, ftype='gas')
setup_star_particle_fields(ptype)[source]
update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

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