yt.frontends.ramses.fields module

RAMSES-specific fields

class yt.frontends.ramses.fields.RAMSESFieldInfo(ds, field_list, slice_info=None)[source]

Bases: yt.fields.field_info_container.FieldInfoContainer

add_field(name, sampling_type, function=None, **kwargs)

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.

  • name (str) – is the name of the field.
  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)
  • 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
  • particle_type (bool) – Is this a particle (1D) field?
  • 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, original_name, units=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None

Returns a new dict with keys from iterable and values equal to value.

get(k[, d]) → D[k] if k in D, else d. d defaults to None.
items() → a set-like object providing a view on D's items
known_other_fields = (('Density', ('code_density', ['density'], None)), ('x-velocity', ('code_velocity', ['velocity_x'], None)), ('y-velocity', ('code_velocity', ['velocity_y'], None)), ('z-velocity', ('code_velocity', ['velocity_z'], None)), ('Pres_IR', ('code_pressure', ['pres_IR'], None)), ('Pressure', ('code_pressure', ['pressure'], None)), ('Metallicity', ('', ['metallicity'], None)), ('HII', ('', ['H_p1_fraction'], None)), ('HeII', ('', ['He_p1_fraction'], None)), ('HeIII', ('', ['He_p2_fraction'], None)))
known_particle_fields = (('particle_position_x', ('code_length', [], None)), ('particle_position_y', ('code_length', [], None)), ('particle_position_z', ('code_length', [], None)), ('particle_velocity_x', ('code_velocity', [], None)), ('particle_velocity_y', ('code_velocity', [], None)), ('particle_velocity_z', ('code_velocity', [], None)), ('particle_mass', ('code_mass', [], None)), ('particle_identifier', ('', ['particle_index'], None)), ('particle_refinement_level', ('', [], None)), ('particle_age', ('code_time', ['age'], None)), ('particle_metallicity', ('', [], None)))
load_plugin(plugin_name, ftype='gas', skip_check=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_particle_fields(ptype, ftype='gas', num_neighbors=64)
setup_smoothed_fields(ptype, num_neighbors=64, ftype='gas')
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