Skip to main content
Ctrl+K
cluster_generator  documentation - Home

Site Navigation

  • Quickstart Guide
  • Examples
  • Cluster Models
  • Simulation Software
  • API

Site Navigation

  • Quickstart Guide
  • Examples
  • Cluster Models
  • Simulation Software
  • API

Section Navigation

  • utils
    • utils.ensure_list
    • utils.ensure_ytarray
    • utils.ensure_ytquantity
    • utils.generate_particle_radii
    • utils.integrate
    • utils.integrate_mass
    • utils.integrate_toinf
    • utils.parse_prng
    • utils.time_limit
    • utils.LogMute
      • utils.LogMute.__init__
  • radial_profiles
    • radial_profiles.ad07_density_profile
    • radial_profiles.ad07_temperature_profile
    • radial_profiles.am06_density_profile
    • radial_profiles.am06_temperature_profile
    • radial_profiles.baseline_entropy_profile
    • radial_profiles.beta_model_profile
    • radial_profiles.broken_entropy_profile
    • radial_profiles.constant_profile
    • radial_profiles.convert_nfw_to_hernquist
    • radial_profiles.cored_hernquist_density_profile
    • radial_profiles.cored_snfw_density_profile
    • radial_profiles.cored_snfw_mass_profile
    • radial_profiles.cored_snfw_total_mass
    • radial_profiles.einasto_density_profile
    • radial_profiles.einasto_mass_profile
    • radial_profiles.find_overdensity_radius
    • radial_profiles.find_radius_mass
    • radial_profiles.hernquist_density_profile
    • radial_profiles.hernquist_mass_profile
    • radial_profiles.nfw_density_profile
    • radial_profiles.nfw_mass_profile
    • radial_profiles.nfw_scale_density
    • radial_profiles.power_law_profile
    • radial_profiles.rescale_profile_by_mass
    • radial_profiles.snfw_conc
    • radial_profiles.snfw_density_profile
    • radial_profiles.snfw_mass_profile
    • radial_profiles.snfw_total_mass
    • radial_profiles.tnfw_density_profile
    • radial_profiles.tnfw_mass_profile
    • radial_profiles.vikhlinin_density_profile
    • radial_profiles.vikhlinin_temperature_profile
    • radial_profiles.walker_entropy_profile
    • radial_profiles.RadialProfile
      • radial_profiles.RadialProfile.__init__
      • radial_profiles.RadialProfile.add_core
      • radial_profiles.RadialProfile.built_in
      • radial_profiles.RadialProfile.cutoff
      • radial_profiles.RadialProfile.from_array
      • radial_profiles.RadialProfile.from_binary
      • radial_profiles.RadialProfile.plot
      • radial_profiles.RadialProfile.to_binary
      • radial_profiles.RadialProfile.builtin
      • radial_profiles.RadialProfile.name
  • fields
    • fields.parse_value
    • fields.rot_3d
    • fields.ClusterField
      • fields.ClusterField.__init__
      • fields.ClusterField.map_field_to_particles
      • fields.ClusterField.write_file
      • fields.ClusterField.units
    • fields.GaussianRandomField
      • fields.GaussianRandomField.__init__
      • fields.GaussianRandomField.map_field_to_particles
      • fields.GaussianRandomField.write_file
      • fields.GaussianRandomField.units
    • fields.RadialRandomMagneticField
      • fields.RadialRandomMagneticField.__init__
      • fields.RadialRandomMagneticField.map_field_to_particles
      • fields.RadialRandomMagneticField.write_file
      • fields.RadialRandomMagneticField.units
    • fields.RadialRandomMagneticVectorPotential
      • fields.RadialRandomMagneticVectorPotential.__init__
      • fields.RadialRandomMagneticVectorPotential.map_field_to_particles
      • fields.RadialRandomMagneticVectorPotential.write_file
      • fields.RadialRandomMagneticVectorPotential.units
    • fields.RadialRandomVelocityField
      • fields.RadialRandomVelocityField.__init__
      • fields.RadialRandomVelocityField.map_field_to_particles
      • fields.RadialRandomVelocityField.write_file
      • fields.RadialRandomVelocityField.units
    • fields.RandomMagneticField
      • fields.RandomMagneticField.__init__
      • fields.RandomMagneticField.map_field_to_particles
      • fields.RandomMagneticField.write_file
      • fields.RandomMagneticField.units
    • fields.RandomMagneticVectorPotential
      • fields.RandomMagneticVectorPotential.__init__
      • fields.RandomMagneticVectorPotential.map_field_to_particles
      • fields.RandomMagneticVectorPotential.write_file
      • fields.RandomMagneticVectorPotential.units
    • fields.RandomVelocityField
      • fields.RandomVelocityField.__init__
      • fields.RandomVelocityField.map_field_to_particles
      • fields.RandomVelocityField.write_file
      • fields.RandomVelocityField.units
  • ics
    • ics.compute_centers_for_binary
    • ics.ClusterICs
      • ics.ClusterICs.__init__
      • ics.ClusterICs.create_dataset
      • ics.ClusterICs.from_file
      • ics.ClusterICs.resample_particle_ics
      • ics.ClusterICs.setup_particle_ics
      • ics.ClusterICs.to_file
  • model
    • model.ClusterModel
      • model.ClusterModel.__init__
      • model.ClusterModel.check_dm_virial
      • model.ClusterModel.check_hse
      • model.ClusterModel.check_star_virial
      • model.ClusterModel.correct
      • model.ClusterModel.create_dataset
      • model.ClusterModel.find_field_at_radius
      • model.ClusterModel.find_radius_for_density
      • model.ClusterModel.from_arrays
      • model.ClusterModel.from_dens_and_entr
      • model.ClusterModel.from_dens_and_tden
      • model.ClusterModel.from_dens_and_temp
      • model.ClusterModel.from_h5_file
      • model.ClusterModel.generate_dm_particles
      • model.ClusterModel.generate_gas_particles
      • model.ClusterModel.generate_star_particles
      • model.ClusterModel.generate_tracer_particles
      • model.ClusterModel.items
      • model.ClusterModel.keys
      • model.ClusterModel.mass_in_radius
      • model.ClusterModel.no_gas
      • model.ClusterModel.panel_plot
      • model.ClusterModel.plot
      • model.ClusterModel.set_field
      • model.ClusterModel.set_magnetic_field_from_beta
      • model.ClusterModel.set_magnetic_field_from_density
      • model.ClusterModel.set_rmax
      • model.ClusterModel.values
      • model.ClusterModel.write_model_to_ascii
      • model.ClusterModel.write_model_to_binary
      • model.ClusterModel.write_model_to_h5
      • model.ClusterModel.default_fields
      • model.ClusterModel.dm_virial
      • model.ClusterModel.is_physical
      • model.ClusterModel.properties
      • model.ClusterModel.star_virial
      • model.ClusterModel.fields
      • model.ClusterModel.num_elements
    • model.HydrostaticEquilibrium
      • model.HydrostaticEquilibrium.__init__
      • model.HydrostaticEquilibrium.check_dm_virial
      • model.HydrostaticEquilibrium.check_hse
      • model.HydrostaticEquilibrium.check_star_virial
      • model.HydrostaticEquilibrium.correct
      • model.HydrostaticEquilibrium.create_dataset
      • model.HydrostaticEquilibrium.find_field_at_radius
      • model.HydrostaticEquilibrium.find_radius_for_density
      • model.HydrostaticEquilibrium.from_arrays
      • model.HydrostaticEquilibrium.from_dens_and_entr
      • model.HydrostaticEquilibrium.from_dens_and_tden
      • model.HydrostaticEquilibrium.from_dens_and_temp
      • model.HydrostaticEquilibrium.from_h5_file
      • model.HydrostaticEquilibrium.generate_dm_particles
      • model.HydrostaticEquilibrium.generate_gas_particles
      • model.HydrostaticEquilibrium.generate_star_particles
      • model.HydrostaticEquilibrium.generate_tracer_particles
      • model.HydrostaticEquilibrium.items
      • model.HydrostaticEquilibrium.keys
      • model.HydrostaticEquilibrium.mass_in_radius
      • model.HydrostaticEquilibrium.no_gas
      • model.HydrostaticEquilibrium.panel_plot
      • model.HydrostaticEquilibrium.plot
      • model.HydrostaticEquilibrium.set_field
      • model.HydrostaticEquilibrium.set_magnetic_field_from_beta
      • model.HydrostaticEquilibrium.set_magnetic_field_from_density
      • model.HydrostaticEquilibrium.set_rmax
      • model.HydrostaticEquilibrium.values
      • model.HydrostaticEquilibrium.write_model_to_ascii
      • model.HydrostaticEquilibrium.write_model_to_binary
      • model.HydrostaticEquilibrium.write_model_to_h5
      • model.HydrostaticEquilibrium.default_fields
      • model.HydrostaticEquilibrium.dm_virial
      • model.HydrostaticEquilibrium.is_physical
      • model.HydrostaticEquilibrium.properties
      • model.HydrostaticEquilibrium.star_virial
      • model.HydrostaticEquilibrium.fields
      • model.HydrostaticEquilibrium.num_elements
  • particles
    • particles.combine_three_clusters
    • particles.combine_two_clusters
    • particles.resample_one_cluster
    • particles.resample_three_clusters
    • particles.resample_two_clusters
    • particles.ClusterParticles
      • particles.ClusterParticles.__init__
      • particles.ClusterParticles.add_black_hole
      • particles.ClusterParticles.add_offsets
      • particles.ClusterParticles.drop_ptypes
      • particles.ClusterParticles.from_fields
      • particles.ClusterParticles.from_file
      • particles.ClusterParticles.from_gadget_file
      • particles.ClusterParticles.from_h5_file
      • particles.ClusterParticles.keys
      • particles.ClusterParticles.make_radial_cut
      • particles.ClusterParticles.set_field
      • particles.ClusterParticles.to_yt_dataset
      • particles.ClusterParticles.write_particles
      • particles.ClusterParticles.write_particles_to_h5
      • particles.ClusterParticles.write_to_gadget_file
      • particles.ClusterParticles.num_passive_scalars
  • relations
    • relations.convert_ne_to_density
    • relations.f_gas
    • relations.m_bcg
    • relations.m_sat
    • relations.r_bcg
    • relations.rho_scale_hern
  • virial
    • virial.VirialEquilibrium
      • virial.VirialEquilibrium.__init__
      • virial.VirialEquilibrium.check_virial
      • virial.VirialEquilibrium.generate_particles
      • virial.VirialEquilibrium.ee
      • virial.VirialEquilibrium.ff
  • cluster_collections
    • cluster_collections.Ascasibar07
      • cluster_collections.Ascasibar07.__init__
      • cluster_collections.Ascasibar07.items
      • cluster_collections.Ascasibar07.keys
      • cluster_collections.Ascasibar07.values
      • cluster_collections.Ascasibar07.authors
      • cluster_collections.Ascasibar07.citation
      • cluster_collections.Ascasibar07.name
      • cluster_collections.Ascasibar07.profiles
      • cluster_collections.Ascasibar07.source_authors
    • cluster_collections.Collection
      • cluster_collections.Collection.__init__
      • cluster_collections.Collection.items
      • cluster_collections.Collection.keys
      • cluster_collections.Collection.values
      • cluster_collections.Collection.authors
      • cluster_collections.Collection.citation
      • cluster_collections.Collection.name
      • cluster_collections.Collection.profiles
      • cluster_collections.Collection.source_authors
    • cluster_collections.ProtoCluster
      • cluster_collections.ProtoCluster.__init__
      • cluster_collections.ProtoCluster.items
      • cluster_collections.ProtoCluster.keys
      • cluster_collections.ProtoCluster.load
      • cluster_collections.ProtoCluster.value
    • cluster_collections.Sanderson10
      • cluster_collections.Sanderson10.__init__
      • cluster_collections.Sanderson10.items
      • cluster_collections.Sanderson10.keys
      • cluster_collections.Sanderson10.values
      • cluster_collections.Sanderson10.authors
      • cluster_collections.Sanderson10.citation
      • cluster_collections.Sanderson10.name
      • cluster_collections.Sanderson10.profiles
      • cluster_collections.Sanderson10.source_authors
    • cluster_collections.Vikhlinin06
      • cluster_collections.Vikhlinin06.__init__
      • cluster_collections.Vikhlinin06.items
      • cluster_collections.Vikhlinin06.keys
      • cluster_collections.Vikhlinin06.values
      • cluster_collections.Vikhlinin06.authors
      • cluster_collections.Vikhlinin06.citation
      • cluster_collections.Vikhlinin06.name
      • cluster_collections.Vikhlinin06.profiles
      • cluster_collections.Vikhlinin06.source_authors
  • codes
    • codes.resample_arepo_ics
    • codes.setup_arepo_ics
    • codes.setup_art_ics
    • codes.setup_athena_ics
    • codes.setup_enzo_ics
    • codes.setup_flash_ics
    • codes.setup_gamer_ics
    • codes.setup_gizmo_ics
    • codes.setup_ramses_ics
    • codes.write_amr_particles
  • API
  • relations
  • relations.co...

relations.convert_ne_to_density#

relations.convert_ne_to_density(ne)[source]#

Convert the electron density to a true density given the mean molecular mass parameter is the standard ~1.6.

Parameters:

ne (unyt.array.unyt_array or unyt.array.unyt_quantity) – The electron density array.

Returns:

The resulting conversion

Return type:

unyt.array.unyt_array or unyt.array.unyt_quantity

previous

relations

next

relations.f_gas

On this page
  • convert_ne_to_density()
Show Source

© Copyright 2020, John ZuHone.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.14.2.