yt.fields.species_fields module

yt.fields.species_fields.add_deprecated_species_alias(registry, ftype, alias_species, species, suffix)

Add a deprecated species alias field.

yt.fields.species_fields.add_deprecated_species_aliases(registry, ftype, alias_species, species)

Add the species aliases but with deprecation warnings.

yt.fields.species_fields.add_nuclei_density_fields(registry, ftype)

yt.fields.species_fields.add_species_aliases(registry, ftype, alias_species, species)

This takes a field registry, a fluid type, and two species names. The first species name is one you wish to alias to an existing species name. For instance you might alias all “H_p0” fields to “H_” fields to indicate that “H_” fields are really just neutral hydrogen fields. This function registers field aliases for the density, number_density, mass, and fraction fields between the two species given in the arguments.

yt.fields.species_fields.add_species_field_by_density(registry, ftype, species)

This takes a field registry, a fluid type, and a species name and then adds the other fluids based on that. This assumes that the field “SPECIES_density” already exists and refers to mass density.

yt.fields.species_fields.add_species_field_by_fraction(registry, ftype, species)

This takes a field registry, a fluid type, and a species name and then adds the other fluids based on that. This assumes that the field “SPECIES_fraction” already exists and refers to mass fraction.

yt.fields.species_fields.setup_species_fields(registry, ftype='gas', slice_info=None)