diff options
| author | Aaron LI <aaronly.me@outlook.com> | 2017-01-16 21:12:19 +0800 |
|---|---|---|
| committer | Aaron LI <aly@aaronly.me> | 2017-06-01 16:33:40 +0800 |
| commit | 41a97ba0be1637c41d32f4c15dca6369a1dc88ae (patch) | |
| tree | 2eb4115bc4b92f9a8db79805bb0706cda6aa6785 | |
| parent | 93dc96a0a6a336419b2e80b221257a8a7532019a (diff) | |
| download | fg21sim-41a97ba0be1637c41d32f4c15dca6369a1dc88ae.tar.bz2 | |
clusters/halo.py: Add zbegin & zend parameters
* Add "zbegin" and "zend" parameters to "calculate_electron_spectrum()"
* Add more detail docstrings
| -rw-r--r-- | fg21sim/extragalactic/clusters/halo.py | 40 |
1 files changed, 37 insertions, 3 deletions
diff --git a/fg21sim/extragalactic/clusters/halo.py b/fg21sim/extragalactic/clusters/halo.py index 6f544d2..a6d5a20 100644 --- a/fg21sim/extragalactic/clusters/halo.py +++ b/fg21sim/extragalactic/clusters/halo.py @@ -100,15 +100,43 @@ class HaloSingle: """ Simulate the merging history of the cluster using the extended Press-Schechter formalism. + + Attributes + ---------- + mtree : `~MergerTree` + Generated merger tree of this cluster. + + Returns + ------- + mtree : `~MergerTree` + Generated merger tree of this cluster. """ self.formation = ClusterFormation(self.M0, self.configs) self.mtree = self.formation.simulate_mergertree() return self.mtree - def calc_electron_spectrum(self): + def calc_electron_spectrum(self, zbegin=None, zend=None): """ Calculate the relativistic electron spectrum by solving the Fokker-Planck equation. + + Parameters + ---------- + zbegin : float, optional + The redshift from where to solve the Fokker-Planck equation. + Default: ``self.zmax``. + zend : float, optional + The redshift where to stop solving the Fokker-Planck equation. + Default: 0 (i.e., present) + + Returns + ------- + p : `~numpy.ndarray` + The momentum grid adopted for solving the equation. + Unit: [mec] + n_e : `~numpy.ndarray` + The solved electron spectrum at ``zend``. + Unit: [cm^-3 mec^-1] """ fpsolver = FokkerPlanckSolver( xmin=self.pmin, xmax=self.pmax, @@ -122,8 +150,14 @@ class HaloSingle: p = fpsolver.x # Assume NO initial electron distribution n0_e = np.zeros(p.shape) - tstart = self.cosmo.age(self.zmax) - tstop = self.cosmo.age0 + if zbegin is None: + tstart = self.cosmo.age(self.zmax) + else: + tstart = self.cosmo.age(zbegin) + if zend is None: + tstop = self.cosmo.age0 + else: + tstop = self.cosmo.age(zend) n_e = fpsolver.solve(u0=n0_e, tstart=tstart, tstop=tstop) return (p, n_e) |