yt.frontends.chombo.fields module

Chombo-specific fields

class yt.frontends.chombo.fields.ChomboFieldInfo(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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = ()
known_particle_fields = ()
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
setup_fluid_fields()
setup_fluid_index_fields()
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
class yt.frontends.chombo.fields.ChomboPICFieldInfo1D(ds, field_list)[source]

Bases: yt.frontends.chombo.fields.ChomboPICFieldInfo3D

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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = (('density', ('code_mass / code_length**3', ['density', 'Density'], None)), ('potential', ('code_length**2 / code_time**2', ['potential', 'Potential'], None)), ('gravitational_field_x', ('code_length / code_time**2', [], None)))
known_particle_fields = (('particle_mass', ('code_mass', [], None)), ('particle_position_x', ('code_length', [], None)), ('particle_velocity_x', ('code_length / code_time', [], None)))
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
setup_fluid_fields()
setup_fluid_index_fields()
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
class yt.frontends.chombo.fields.ChomboPICFieldInfo2D(ds, field_list)[source]

Bases: yt.frontends.chombo.fields.ChomboPICFieldInfo3D

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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = (('density', ('code_mass / code_length**3', ['density', 'Density'], None)), ('potential', ('code_length**2 / code_time**2', ['potential', 'Potential'], None)), ('gravitational_field_x', ('code_length / code_time**2', [], None)), ('gravitational_field_y', ('code_length / code_time**2', [], None)))
known_particle_fields = (('particle_mass', ('code_mass', [], None)), ('particle_position_x', ('code_length', [], None)), ('particle_position_y', ('code_length', [], None)), ('particle_velocity_x', ('code_length / code_time', [], None)), ('particle_velocity_y', ('code_length / code_time', [], None)))
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
setup_fluid_fields()
setup_fluid_index_fields()
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
class yt.frontends.chombo.fields.ChomboPICFieldInfo3D(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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = (('density', ('code_mass / code_length**3', ['density', 'Density'], None)), ('potential', ('code_length**2 / code_time**2', ['potential', 'Potential'], None)), ('gravitational_field_x', ('code_length / code_time**2', [], None)), ('gravitational_field_y', ('code_length / code_time**2', [], None)), ('gravitational_field_z', ('code_length / code_time**2', [], None)))
known_particle_fields = (('particle_mass', ('code_mass', [], None)), ('particle_position_x', ('code_length', [], None)), ('particle_position_y', ('code_length', [], None)), ('particle_position_z', ('code_length', [], None)), ('particle_velocity_x', ('code_length / code_time', [], None)), ('particle_velocity_y', ('code_length / code_time', [], None)), ('particle_velocity_z', ('code_length / code_time', [], None)))
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
setup_fluid_fields()
setup_fluid_index_fields()
setup_particle_fields(ptype, ftype='gas', num_neighbors=64)[source]
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
class yt.frontends.chombo.fields.Orion2FieldInfo(ds, field_list, slice_info=None)[source]

Bases: yt.frontends.chombo.fields.ChomboFieldInfo

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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = (('density', ('code_mass / code_length**3', ['density'], None)), ('energy-density', ('code_mass / (code_time**2 * code_length)', ['energy_density'], None)), ('radiation-energy-density', ('code_mass / (code_time**2 * code_length)', ['radiation_energy_density'], None)), ('X-momentum', ('code_mass / (code_time * code_length**2)', ['momentum_x'], None)), ('Y-momentum', ('code_mass / (code_time * code_length**2)', ['momentum_y'], None)), ('Z-momentum', ('code_mass / (code_time * code_length**2)', ['momentum_z'], None)), ('temperature', ('K', ['temperature'], None)), ('X-magnfield', ('code_magnetic', [], None)), ('Y-magnfield', ('code_magnetic', [], None)), ('Z-magnfield', ('code_magnetic', [], None)), ('directrad-dedt-density', ('code_mass / (code_time**2 * code_length)', ['directrad-dedt-density'], None)), ('directrad-dpxdt-density', ('code_mass / (code_time * code_length**2)', ['directrad-dpxdt-density'], None)), ('directrad-dpydt-density', ('code_mass / (code_time * code_length**2)', ['directrad-dpydt-density'], None)), ('directrad-dpzdt-density', ('code_mass / (code_time * code_length**2)', ['directrad-dpzdt-density'], None)))
known_particle_fields = (('particle_mass', ('code_mass', [], None)), ('particle_position_x', ('code_length', [], None)), ('particle_position_y', ('code_length', [], None)), ('particle_position_z', ('code_length', [], None)), ('particle_momentum_x', ('code_mass*code_length/code_time', [], None)), ('particle_momentum_y', ('code_mass*code_length/code_time', [], None)), ('particle_momentum_z', ('code_mass*code_length/code_time', [], None)), ('particle_angmomen_x', ('code_length**2/code_time', [], None)), ('particle_angmomen_y', ('code_length**2/code_time', [], None)), ('particle_angmomen_z', ('code_length**2/code_time', [], None)), ('particle_mlast', ('code_mass', [], None)), ('particle_r', ('code_length', [], None)), ('particle_mdeut', ('code_mass', [], None)), ('particle_n', ('', [], None)), ('particle_mdot', ('code_mass/code_time', [], None)), ('particle_burnstate', ('', [], None)), ('particle_luminosity', ('', [], None)), ('particle_id', ('', ['particle_index'], None)))
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
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 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
class yt.frontends.chombo.fields.PlutoFieldInfo(ds, field_list, slice_info=None)[source]

Bases: yt.frontends.chombo.fields.ChomboFieldInfo

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.

Parameters:
  • 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)
check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys()

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.
has_key(key)
items() → a set-like object providing a view on D's items
keys()
known_other_fields = (('rho', ('code_mass / code_length**3', ['density'], None)), ('prs', ('code_mass / (code_length * code_time**2)', ['pressure'], None)), ('vx1', ('code_length / code_time', ['velocity_x'], None)), ('vx2', ('code_length / code_time', ['velocity_y'], None)), ('vx3', ('code_length / code_time', ['velocity_z'], None)), ('bx1', ('code_magnetic', [], None)), ('bx2', ('code_magnetic', [], None)), ('bx3', ('code_magnetic', [], None)))
known_particle_fields = ()
load_all_plugins(ftype='gas')
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_extra_union_fields(ptype='all')
setup_fluid_aliases()
setup_fluid_fields()[source]
setup_fluid_index_fields()
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