yt.frontends.ramses.fields module¶

class yt.frontends.ramses.fields.RAMSESFieldInfo(ds, field_list: list[tuple[str, str]], slice_info=None)[source]¶

Bases: FieldInfoContainer

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()¶

create_cooling_fields() → bool[source]¶: Create cooling fields from the cooling files. Return True if successful.

create_gravity_fields()[source]¶

create_magnetic_fields()[source]¶

create_rt_fields()[source]¶

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.¶

get_aliases_gallery() → list[str]¶

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: tuple[tuple[str, tuple[str, list[str], str | None]], ...] = (('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', 'pressure_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)), ('x-acceleration', ('code_length / code_time**2', ['acceleration_x'], None)), ('y-acceleration', ('code_length / code_time**2', ['acceleration_y'], None)), ('z-acceleration', ('code_length / code_time**2', ['acceleration_z'], None)), ('Potential', ('code_velocity**2', ['potential'], None)), ('B_x_left', ('code_magnetic', ['magnetic_field_x_left'], None)), ('B_x_right', ('code_magnetic', ['magnetic_field_x_right'], None)), ('B_y_left', ('code_magnetic', ['magnetic_field_y_left'], None)), ('B_y_right', ('code_magnetic', ['magnetic_field_y_right'], None)), ('B_z_left', ('code_magnetic', ['magnetic_field_z_left'], None)), ('B_z_right', ('code_magnetic', ['magnetic_field_z_right'], None)))¶

known_particle_fields: tuple[tuple[str, tuple[str, list[str], str | None]], ...] = (('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_identity', ('', ['particle_index'], None)), ('particle_refinement_level', ('', [], None)), ('particle_birth_time', ('code_time', ['age'], None)), ('conformal_birth_time', ('', [], None)), ('particle_metallicity', ('', [], None)), ('particle_family', ('', [], None)), ('particle_tag', ('', [], None)), ('particle_mass', ('code_mass', [], None)), ('particle_angular_momentum_x', ('code_mass * code_velocity * code_length', [], None)), ('particle_angular_momentum_y', ('code_mass * code_velocity * code_length', [], None)), ('particle_angular_momentum_z', ('code_mass * code_velocity * code_length', [], None)), ('particle_formation_time', ('code_time', [], None)), ('particle_accretion_rate', ('code_mass/code_time', [], None)), ('particle_delta_mass', ('code_mass', [], None)), ('particle_rho_gas', ('code_density', [], None)), ('particle_cs**2', ('code_velocity', [], None)), ('particle_etherm', ('code_mass * code_velocity**2', [], None)), ('particle_velocity_x_gas', ('code_velocity', [], None)), ('particle_velocity_y_gas', ('code_velocity', [], None)), ('particle_velocity_z_gas', ('code_velocity', [], None)), ('particle_mass_bh', ('code_mass', [], None)), ('particle_level', ('', [], None)), ('particle_radius_star', ('code_length', [], None)))¶

known_sink_fields: tuple[tuple[str, tuple[str, list[str], str | None]], ...] = (('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_birth_time', ('code_time', ['age'], None)), ('BH_real_accretion', ('code_mass/code_time', [], None)), ('BH_bondi_accretion', ('code_mass/code_time', [], None)), ('BH_eddington_accretion', ('code_mass/code_time', [], None)), ('BH_esave', ('code_mass * code_velocity**2', [], None)), ('gas_spin_x', ('code_mass * code_velocity * code_length', [], None)), ('gas_spin_y', ('code_mass * code_velocity * code_length', [], None)), ('gas_spin_z', ('code_mass * code_velocity * code_length', [], None)), ('BH_spin_x', ('', [], None)), ('BH_spin_y', ('', [], None)), ('BH_spin_z', ('', [], None)), ('BH_spin', ('code_mass * code_velocity * code_length', [], None)), ('BH_efficiency', ('', [], 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()[source]¶

setup_fluid_index_fields()¶

setup_particle_fields(ptype)[source]¶

setup_smoothed_fields(ptype, num_neighbors=64, ftype='gas')¶

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¶