redback.transient_models.magnetar_driven_ejecta_models.general_metzger_magnetar_driven_thermalisation

redback.transient_models.magnetar_driven_ejecta_models.general_metzger_magnetar_driven_thermalisation(time, redshift, mej, vej, beta, kappa_r, l0, tau_sd, nn, kappa_gamma, **kwargs)[source]
Parameters:

  • time – observer frame time in days

  • redshift – redshift

  • mej – ejecta mass in solar masses

  • vej – minimum initial velocity

  • beta – velocity power law slope (M=v^-beta)

  • kappa_r – opacity

  • l0 – initial magnetar X-ray luminosity

  • tau_sd – magnetar spin down damping timescale

  • nn – braking index

  • kappa_gamma – gamma-ray opacity used to calculate magnetar thermalisation efficiency

  • kwargs – Additional parameters

  • albedo (ejecta) – ejecta albedo; default is 0.5

  • pair_cascade_fraction – fraction of magnetar luminosity lost to pair cascades; default is 0.05

  • neutron_precursor_switch – whether to have neutron precursor emission, default true

  • pair_cascade_switch – whether to account for pair cascade losses, default is True

  • magnetar_heating – whether magnetar heats all layers or just the bottom layer. default first layer only

  • vmax – maximum initial velocity of mass layers, default is 0.7c

  • frequency – Required if output_format is ‘flux_density’. frequency to calculate - Must be same length as time array or a single number).

  • bands – Required if output_format is ‘magnitude’ or ‘flux’.

  • output_format – ‘flux_density’, ‘magnitude’, ‘spectra’, ‘flux’, ‘sncosmo_source’

  • lambda_array – Optional argument to set your desired wavelength array (in Angstroms) to evaluate the SED on.

  • cosmology – Cosmology to use for luminosity distance calculation. Defaults to Planck18. Must be a astropy.cosmology object.

Returns:

set by output format - ‘flux_density’, ‘magnitude’, ‘spectra’, ‘flux’, ‘sncosmo_source’