Class inverse Compton, inherited from Radiation.hpp. More...

#include <Compton.hpp>

Inheritance diagram for kariba::Compton:

Public Member Functions
	~Compton ()

	Compton (size_t size, size_t target_size)

virtual double	comintegral (size_t it, double blim, double ulim, double nu, double numin, double numax, gsl_spline eldis, gsl_interp_accel acc_eldis)

virtual void	compton_spectrum (double gmin, double gmax, gsl_spline eldis, gsl_interp_accel acc_eldis)

virtual void	set_target_energy_array (const std::vector< double > &new_target_energy)
	Method to set new target energy array, resets also log_target_diff_spec.

virtual void	set_target_frequency_array (const std::vector< double > &new_target_frequency)
	Method to set target energy array from frequency array, resets also log_target_diff_spec.

virtual void	add_target_diff_spec (const std::vector< double > &new_target_diff_spec)

virtual void	add_target_energy_density (const std::vector< double > &new_target_energy, const std::vector< double > &new_target_energy_density)

virtual void	add_target_number_density (const std::vector< double > &new_target_energy, const std::vector< double > &new_target_number_density)

virtual void	add_target_number_density_on_freq_grid (const std::vector< double > &new_target_frequency, const std::vector< double > &new_target_number_density)

virtual void	cyclosyn_seed (const std::vector< double > &syn_energies, const std::vector< double > &syn_number_rates)

virtual void	bb_seed_k (double Urad, double Tbb)

virtual void	bb_seed_kev (double Urad, double Tbb)

virtual void	shsdisk_seed (double tin, double rin, double rout, double h, double z)

virtual void	set_niter (double nu0, double Te)

virtual void	set_niter (size_t n)

virtual void	set_tau (double n, double gam)

virtual void	set_tau (double _tau)

virtual void	set_frequency (double numin, double numax)
	Method to set up the frequency array over desired range.

virtual void	set_escape (double escape)

virtual std::vector< double >	get_target_energy () const

virtual std::vector< double >	get_target_diff_spec () const

virtual double	get_tau () const

virtual double	get_ypar () const

virtual void	reset ()

virtual void	urad_test ()

virtual void	test ()

virtual void	bb_seed_k (const std::vector< double > &seed_arr, double Urad, double Tbb)

virtual void	bb_seed_kev (const std::vector< double > &seed_arr, double Urad, double Tbb)

virtual void	shsdisk_seed (const std::vector< double > &seed_arr, double tin, double rin, double rout, double h, double z)

Public Member Functions inherited from kariba::Radiation
	Radiation (size_t size)

virtual const std::vector< double > &	get_energy () const

virtual const std::vector< double > &	get_nphot () const

virtual const std::vector< double > &	get_energy_obs () const

virtual const std::vector< double > &	get_nphot_obs () const

virtual size_t	get_size () const

virtual double	get_volume () const

virtual double	integrated_luminosity (double numin, double numax)

virtual void	set_beaming (double theta, double speed, double doppler)
	Methods to set viewing angle, beaming and geometry of emission region.

virtual void	set_inclination (double theta)

virtual void	set_geometry (const std::string &geom, double l1, double l2)

virtual void	set_geometry (const std::string &geom, double l1)

virtual void	set_counterjet (bool flag)
	Method to include a counterjet in cyclosycnchrotron/Compton classes.

virtual void	test_arrays ()
	Simple method to check arrays; only meant for debugging.

Protected Attributes
const double	log_floor = -230

size_t	Niter
	number of IC iterations

double	tau

double	ypar
	optical depth/comtpon Y of emitting region

double	rphot
	photospheric radius when tau > 1, used to renormalize volume

double	escape_corr
	escape term, used to renormalize our spectra to CompPS

std::vector< double >	target_energy
	array of seed energies in erg

std::vector< double >	log_target_diff_spec
	array of seed photon number density in log(#/erg/cm^3)

std::vector< double >	log_target_diff_spec_iter
	array of iterated photon number density in log(#/erg/cm^3)

gsl_spline *	seed_ph
	interpolation of photon field array target_diff_spec

gsl_interp_accel *	acc_seed
	accelerator for above spline

gsl_spline *	iter_ph
	interpolation of photon field for multiple scatters

gsl_interp_accel *	acc_iter
	accelerator of above spline

gsl_spline2d *	esc_p_sph
	radiative transfer

gsl_spline2d *	esc_p_cyl
	radiative transfer

gsl_interp_accel *	acc_tau
	accelerator of above spline over tau

gsl_interp_accel *	acc_Te
	accelerator of above spline over Te

gsl_integration_workspace *	w1

gsl_integration_workspace *	w2

Protected Attributes inherited from kariba::Radiation
std::vector< double >	en_phot
	array of photon energies

std::vector< double >	num_phot
	array of number of photons in units of erg/s/Hz

std::vector< double >	en_phot_obs
	same as above but in observer frame

std::vector< double >	num_phot_obs
	same as above but in observer frame

double	r

double	z
	Dimensions of emitting region.

double	vol
	Volume of emitting region.

double	beta
	speed of the emitting region

double	dopfac

double	angle
	Viewing angle/Doppler factor of emitting region.

double	dopnum
	Doppler boosting exponent, depends on geometry.

bool	counterjet
	boolean switch if user wants to include counterjet emission

std::string	geometry
	string to track geometry of emitting region

Friends
double	comfnc (double logein, void *pars)

double	comint (double gam, void *pars)

double	disk_integral (double alfa, void *p)

Detailed Description

Class inverse Compton, inherited from Radiation.hpp.

Constructor & Destructor Documentation

◆ ~Compton()

kariba::Compton::~Compton ( )

◆ Compton()

kariba::Compton::Compton	(	size_t	size,
		size_t	target_size
	)

Member Function Documentation

◆ add_target_diff_spec()

void kariba::Compton::add_target_diff_spec ( const std::vector< double > & new_target_diff_spec )

virtual

◆ add_target_energy_density()

void kariba::Compton::add_target_energy_density	(	const std::vector< double > &	new_target_energy,
		const std::vector< double > &	new_target_energy_density
	)

virtual

◆ add_target_number_density()

void kariba::Compton::add_target_number_density	(	const std::vector< double > &	new_target_energy,
		const std::vector< double > &	new_target_number_density
	)

virtual

◆ add_target_number_density_on_freq_grid()

void kariba::Compton::add_target_number_density_on_freq_grid	(	const std::vector< double > &	new_target_frequency,
		const std::vector< double > &	new_target_number_density
	)

virtual

◆ bb_seed_k() [1/2]

virtual void kariba::Compton::bb_seed_k	(	const std::vector< double > &	seed_arr,
		double	Urad,
		double	Tbb
	)

inlinevirtual

Deprecated:: Use bb_seed_k(Urad, Tbb) instead.

◆ bb_seed_k() [2/2]

void kariba::Compton::bb_seed_k	(	double	Urad,
		double	Tbb
	)

virtual

Method to include black body to seed field for IC; Note: Urad and Tbb need to be passed in the co-moving frame, the function does NOT account for beaming

◆ bb_seed_kev() [1/2]

virtual void kariba::Compton::bb_seed_kev	(	const std::vector< double > &	seed_arr,
		double	Urad,
		double	Tbb
	)

inlinevirtual

Deprecated:: Use bb_seed_kev(Urad, Tbb) instead.

◆ bb_seed_kev() [2/2]

void kariba::Compton::bb_seed_kev	(	double	Urad,
		double	Tbb
	)

virtual

◆ comintegral()

double kariba::Compton::comintegral	(	size_t	it,
		double	blim,
		double	ulim,
		double	enphot,
		double	enphmin,
		double	enphmax,
		gsl_spline *	eldis,
		gsl_interp_accel *	acc_eldis
	)

virtual

This integrates the individual electron spectrum from comint over the total electron distribution

◆ compton_spectrum()

void kariba::Compton::compton_spectrum	(	double	gmin,
		double	gmax,
		gsl_spline *	eldis,
		gsl_interp_accel *	acc_eldis
	)

virtual

This calculates the final spectrum in all frequency bins, including multiple scatters. Note: the reason the Doppler boosting is a factor of 2 instead of 3 is because the calculations are done for a conical jet in the Lind&BLanford 1985 prescription

◆ cyclosyn_seed()

void kariba::Compton::cyclosyn_seed	(	const std::vector< double > &	syn_energies,
		const std::vector< double > &	syn_number_rates
	)

virtual

Method to include cyclosynchrotron array from Cyclosyn.hh to the seed field. The two input arrays should be get_energ() and get_nphot() methods from Cyclosyn.hh. If the target_diff_spec array wasn't empty, the contribution is automatically added to the existing one. note: the second condition has a <= sign to dodge numerical errors when the seed field energy density is extremely low, which can result in negative values/nan for the target_diff_spec

◆ get_target_diff_spec()

std::vector< double > kariba::Compton::get_target_diff_spec ( ) const

virtual

◆ get_target_energy()

std::vector< double > kariba::Compton::get_target_energy ( ) const

virtual

◆ get_tau()

virtual double kariba::Compton::get_tau ( ) const

inlinevirtual

◆ get_ypar()

virtual double kariba::Compton::get_ypar ( ) const

inlinevirtual

◆ reset()

void kariba::Compton::reset ( )

virtual

This resets the energy density in case different photon fields want to be calculated separately to see the contribution of each

◆ set_escape()

void kariba::Compton::set_escape ( double escape )

virtual

This method is to hard-code an escape term, e.g. to implement a different geometry

◆ set_frequency()

void kariba::Compton::set_frequency	(	double	numin,
		double	numax
	)

virtual

Method to set up the frequency array over desired range.

◆ set_niter() [1/2]

void kariba::Compton::set_niter	(	double	nu0,
		double	Te
	)

virtual

Method to estimate the number of scatterings the electrons go through; scatters are repeated until the photons reach the same typical energy as the electrons Input parameters are initial scale frequency of photons in Hz and temperature of scattering electrons in erg note: this assumes that a) the final energy of the photons is set only by the electrons and b) that the photons have one scale energy only; it could be incorrect if scattering multiple photon fields (e.g. disk and cyclosynchrotron)

◆ set_niter() [2/2]

void kariba::Compton::set_niter ( size_t n )

virtual

◆ set_target_energy_array()

void kariba::Compton::set_target_energy_array ( const std::vector< double > & new_target_energy )

virtual

Method to set new target energy array, resets also log_target_diff_spec.

◆ set_target_frequency_array()

void kariba::Compton::set_target_frequency_array ( const std::vector< double > & new_target_frequency )

virtual

Method to set target energy array from frequency array, resets also log_target_diff_spec.

◆ set_tau() [1/2]

void kariba::Compton::set_tau ( double _tau )

virtual

◆ set_tau() [2/2]

void kariba::Compton::set_tau	(	double	n,
		double	Te
	)

virtual

Sets optical depth for given number density of emitting region (assuming radius is set correctly), and compton-Y for a given electron average Lorentz factor. In some cases not covered by the radiative transfer tables, escape_corr reverts to the constructor default value of 1.

◆ shsdisk_seed() [1/2]

virtual void kariba::Compton::shsdisk_seed	(	const std::vector< double > &	seed_arr,
		double	tin,
		double	rin,
		double	rout,
		double	h,
		double	z
	)

inlinevirtual

Deprecated:: Use shsdisk_seed(tin, rin, rout, h, z) instead.

◆ shsdisk_seed() [2/2]

void kariba::Compton::shsdisk_seed	(	double	tin,
		double	rin,
		double	rout,
		double	h,
		double	z
	)

virtual

◆ test()

void kariba::Compton::test ( )

virtual

◆ urad_test()

void kariba::Compton::urad_test ( )

virtual

Friends And Related Symbol Documentation

◆ comfnc

double comfnc	(	double	logein,
		void *	pars
	)

friend

This function is the kernel of eq 2.48 in Blumenthal & Gould(1970), represents the scattered photon spectrum for a given electron and includes the Klein-Nishina cross section.

◆ comint

double comint	(	double	gam,
		void *	pars
	)

friend

This function is the integral of comfnc above over the total seed photon distribution

◆ disk_integral

double disk_integral	(	double	alfa,
		void *	p
	)

friend

Calculates incident photon field for a Shakura-Sunyaev disk with aspect ratio H, inner temperature Tin, inner radius Rin, at a distance z from the disk, taking beaming into account

Member Data Documentation

◆ acc_iter

gsl_interp_accel* kariba::Compton::acc_iter

protected

accelerator of above spline

◆ acc_seed

gsl_interp_accel* kariba::Compton::acc_seed

protected

accelerator for above spline

◆ acc_tau

gsl_interp_accel* kariba::Compton::acc_tau

protected

accelerator of above spline over tau

◆ acc_Te

gsl_interp_accel* kariba::Compton::acc_Te

protected

accelerator of above spline over Te

◆ esc_p_cyl

gsl_spline2d* kariba::Compton::esc_p_cyl

protected

radiative transfer

interpolation for escape calculation to mimic

◆ esc_p_sph

gsl_spline2d* kariba::Compton::esc_p_sph

protected

radiative transfer

interpolation for escape calculation to mimic

◆ escape_corr

double kariba::Compton::escape_corr

protected

escape term, used to renormalize our spectra to CompPS

◆ iter_ph

gsl_spline* kariba::Compton::iter_ph

protected

interpolation of photon field for multiple scatters

◆ log_floor

const double kariba::Compton::log_floor = -230

protected

◆ log_target_diff_spec

std::vector<double> kariba::Compton::log_target_diff_spec

protected

array of seed photon number density in log(#/erg/cm^3)

◆ log_target_diff_spec_iter

std::vector<double> kariba::Compton::log_target_diff_spec_iter

protected

array of iterated photon number density in log(#/erg/cm^3)

◆ Niter

size_t kariba::Compton::Niter

protected

number of IC iterations

◆ rphot

double kariba::Compton::rphot

protected

photospheric radius when tau > 1, used to renormalize volume

◆ seed_ph

gsl_spline* kariba::Compton::seed_ph

protected

interpolation of photon field array target_diff_spec

◆ target_energy

std::vector<double> kariba::Compton::target_energy

protected

array of seed energies in erg

◆ tau

double kariba::Compton::tau

protected

◆ w1

gsl_integration_workspace* kariba::Compton::w1

protected

◆ w2

gsl_integration_workspace* kariba::Compton::w2

protected

◆ ypar

double kariba::Compton::ypar

protected

optical depth/comtpon Y of emitting region

The documentation for this class was generated from the following files:

/home/runner/work/kariba/kariba/src/kariba/Compton.hpp
/home/runner/work/kariba/kariba/src/Compton.cpp

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Compton()

◆ Compton()

Member Function Documentation

◆ add_target_diff_spec()

◆ add_target_energy_density()

◆ add_target_number_density()

◆ add_target_number_density_on_freq_grid()

◆ bb_seed_k() [1/2]

◆ bb_seed_k() [2/2]

◆ bb_seed_kev() [1/2]

◆ bb_seed_kev() [2/2]

◆ comintegral()

◆ compton_spectrum()

◆ cyclosyn_seed()

◆ get_target_diff_spec()

◆ get_target_energy()

◆ get_tau()

◆ get_ypar()

◆ reset()

◆ set_escape()

◆ set_frequency()

◆ set_niter() [1/2]

◆ set_niter() [2/2]

◆ set_target_energy_array()

◆ set_target_frequency_array()

◆ set_tau() [1/2]

◆ set_tau() [2/2]

◆ shsdisk_seed() [1/2]

◆ shsdisk_seed() [2/2]

◆ test()

◆ urad_test()

Friends And Related Symbol Documentation

◆ comfnc

◆ comint

◆ disk_integral

Member Data Documentation

◆ acc_iter

◆ acc_seed

◆ acc_tau

◆ acc_Te

◆ esc_p_cyl

◆ esc_p_sph

◆ escape_corr

◆ iter_ph

◆ log_floor

◆ log_target_diff_spec

◆ log_target_diff_spec_iter

◆ Niter

◆ rphot

◆ seed_ph

◆ target_energy

◆ tau

◆ w1

◆ w2

◆ ypar