HOD_Quenching_Model

class halotools.halo_occupation.HOD_Quenching_Model

Bases: halotools.halo_occupation.HOD_Model

Abstract base class for models determining mock galaxy quenching. A subclass of HOD_Mock, this class additionally requires methods specifying the quenched fractions of centrals and satellites.

Attributes Summary

baseline_hod_model

Underlying HOD model.

Methods Summary

mean_quenched_fraction_centrals(...)	Expected fraction of centrals that are quenched as a function of the primary halo property.
mean_quenched_fraction_satellites(...)	Expected fraction of satellites that are quenched as a function of the primary halo property.

Attributes Documentation

baseline_hod_model

Underlying HOD model.

Must be one of the supported subclasses of HOD_Model. The baseline HOD model can in principle be driven by any host halo property, and can have distinct quenched/star-forming SMHM relations.

Methods Documentation

mean_quenched_fraction_centrals(primary_halo_property, halo_type)

Expected fraction of centrals that are quenched as a function of the primary halo property. A required method for any halo occupation object with quenching designation.

mean_quenched_fraction_satellites(primary_halo_property, halo_type)

Expected fraction of satellites that are quenched as a function of the primary halo property. A required method for any halo occupation object with quenching designation.