CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
ncdm_base_species.h
1#pragma once
2#include <memory>
3#include <string>
4#include <tuple>
5#include <vector>
6
7#include "../species/base_species.h"
8#include "background.h"
9#include "parser.h"
10#include "quadrature.h"
11
12class BackgroundModule;
13
14#ifndef _zeta3_
15#define _zeta3_ \
16 1.2020569031595942853997381615114499907649862923404988817922
17#endif
18#ifndef _zeta5_
19#define _zeta5_ \
20 1.0369277551433699263313654864570341680570809195019128119741
21#endif
22#ifndef _PSD_DERIVATIVE_EXP_MIN_
23#define _PSD_DERIVATIVE_EXP_MIN_ (-30)
24#endif
25#ifndef _PSD_DERIVATIVE_EXP_MAX_
26#define _PSD_DERIVATIVE_EXP_MAX_ 2
27#endif
28
29struct NcdmSettings {
30 double h = 0.;
31 double T_cmb = 0.;
32 double tol_ncdm = 0.;
33 double tol_ncdm_bg = 0.;
34 double tol_M_ncdm = 0.;
35 bool normalise_drivers = true;
36};
37
44 public:
47 int MaxMultipole(const precision* ppr, bool /*tensors*/) const override {
48 return LMax(ppr);
49 }
50
53 int LMax(const precision* ppr) const {
54 return l_max_input_ > 0 ? l_max_input_ : ppr->l_max_ncdm;
55 }
57 void SetLMaxInput(int l_max) {
58 l_max_input_ = l_max;
59 }
60
62 bool HasNcdm() const override {
63 return true;
64 }
65
66 // ── PerturbLayout ─────────────────────────────────────────────────────────
73 int l_max = -1;
74 int q_size = -1;
75 std::vector<int> index_per_q; // absolute offsets into pv->y, one per momentum bin
76 int total_size() const {
77 return q_size * (l_max + 1);
78 }
79 };
80
81 std::unique_ptr<BaseSpecies::PerturbLayout> CreatePerturbLayout() const override {
82 return std::make_unique<PerturbLayout>();
83 }
84
85 // ── Public accessors ──────────────────────────────────────────────────────
86 double GetOmega0() const override;
87 double GetNeff(double z) const;
88 double GetMassInElectronvolt() const {
89 return m_in_eV_;
90 }
91 double GetDeg() const {
92 return deg_;
93 }
95 double GetT() const {
96 return T_;
97 }
100 double GetKsi() const {
101 return ksi_;
102 }
105 bool UsesPsdFile() const {
106 return got_file_;
107 }
117 double rho_nu_rel() const {
118 return rho_nu_rel_;
119 }
125 bool ClustersAsMatter() const override {
126 return true;
127 }
128 bool IsColdMatterSpecies() const override {
129 return false;
130 }
131
132 double GetIni(double a, double tol_ncdm_initial_w) const;
133
135 double BackgroundAIni(double a_proposed, double tol) const override {
136 return GetIni(a_proposed, tol);
137 }
138
139 double GetRescalingFactor(const double* lnf_array) const;
140 virtual std::tuple<double, double> GetRescaledParameters(double a, const double* lnf_array) const;
141
142 // Called from NCDMSpecies/DNCDMSpecies background methods
143 void ComputeMomenta(
144 double z, double* n, double* rho, double* p, double* drho_dM, double* pseudo_p) const;
145
147 double BackgroundDensityOverH0Sq(double a, double H0) const override;
148
149 int q_size() const {
150 return static_cast<int>(q_.size());
151 }
152 int q_size_bg() const {
153 return static_cast<int>(q_bg_.size());
154 }
155
156 // Public accessors for quadrature/distribution data (used by module code)
157 const std::vector<double>& q() const {
158 return q_;
159 }
160 const std::vector<double>& w() const {
161 return w_;
162 }
163 const std::vector<double>& dlnf0_dlnq() const {
164 return dlnf0_dlnq_;
165 }
166 double M() const {
167 return M_;
168 }
169 double factor() const {
170 return factor_;
171 }
172
173 void PrintNeffInfo() const override;
174 void PrintMassInfo() const override;
175
176 double NeutrinoOmega0() const override {
177 return GetOmega0();
178 }
179 double NeffContribution(double z) const override {
180 return GetNeff(z);
181 }
182 double TensorMasslessRelativisticRho(const double* pvecback) const override {
183 return 3. * P(pvecback);
184 }
185 double DeviationFromRadiation(const double* pvecback) const override {
186 return fabs(P(pvecback) / Rho(pvecback) - 1. / 3.);
187 }
188 void WarnIfNonlinearUnreliable(double m_ev_threshold) const override;
189 std::vector<double> FreeStreamingWavenumbers() const override;
190
191 void SetDeg_from_Omega_ini(double z_ini, double H0, double Omega_ini);
192
193 // Background overrides (shared by NCDMSpecies and DNCDMSpecies)
194 void SetBackgroundModule(const BackgroundModule* bgm) override {
195 bgm_ = bgm;
196 }
197 void SetPerturbs(const perturbs* ppt) override {
198 ppt_ = ppt;
199 }
200
201 void RegisterTransferSourceIndices(int& index_tp, const SourceRequestContext& ctx) override;
202
203 // ── Layout-based tensor register (shared by NCDM and DNCDM) ──────────────
204 void RegisterTensorPerturbationIndices(BaseSpecies::PerturbLayout& base,
205 perturb_vector* pv,
206 const precision* ppr,
207 int& index_pt,
208 const perturb_workspace* ppw,
209 int gauge) override;
210
211 // ── Layout-based tensor Boltzmann hierarchy ───────────────────────────────
216 double tau,
217 const double* y,
218 double* dy,
219 const perturb_parameters_and_workspace& ppaw) const override;
220
224 double* y,
225 double f0,
226 const double* pvecback) const override;
227
228 // ── Tensor GW source contribution ────────────────────────────────────────
232 double a,
233 const double* y,
234 perturb_workspace* ppw) const override;
235
236 // ── MarkUsedInSources ────────────────────────────────────────────────────
239 const perturb_workspace* ppw,
240 int* used_in_sources) const override;
241
243 double* y,
244 const PerturbIcContext& ctx) override;
245
246 // ── CopyPerturbationsAcrossSwitch ─────────────────────────────────────────
255 const BaseSpecies::PerturbLayout& new_base,
256 const double* old_y,
257 double* new_y,
258 const PerturbSwitchContext& ctx) const override;
259
260 protected:
262 int l_max_input_ = -1;
263
264 int index_tp_delta_ = -1; // #309 transfer-source slot (this ncdm flavor)
265 int index_tp_theta_ = -1;
266
270 virtual double GetDlnf0Dlnq(int iq, const double* pvecback) const = 0;
271
274 virtual double GetW0ForGwSource(int iq, const double* pvecback) const;
275
278 virtual double EvaluatePsdAnalytic(double q) const;
279
284 virtual quadrature_method DefaultQuadratureStrategy() const {
285 return qm_auto;
286 }
287
289 virtual void FillQuadratureParams(GBQuadParams& /*p*/) const {}
290
291 // Constructor: reads parameters per-instance via SpeciesInput (dot-syntax).
292 NCDMBaseSpecies(std::string name,
293 EnergyType energy_type,
294 FileContent* pfc,
295 const std::string& instance_name,
296 const NcdmSettings& settings);
297
301 struct DeferInit {};
302
303 NCDMBaseSpecies(std::string name,
304 EnergyType energy_type,
305 FileContent* pfc,
306 const std::string& instance_name,
307 const NcdmSettings& settings,
308 DeferInit defer);
309
313 void BuildQuadratureAndMass(const NcdmSettings& settings);
314
315 void InitQuadrature(const NcdmSettings& settings);
316
317 void SetOmega0(double Omega0, double h);
318 void SetDegAndFactor(double deg);
319
320 // Momenta variant with variable degeneracy (used by SetDeg_from_Omega_ini):
321 void ComputeMomentaDeg(double deg,
322 double z,
323 double* n,
324 double* rho,
325 double* p,
326 double* drho_ddeg,
327 double* pseudo_p) const;
328
329 // Infer M from Omega:
330 double MFromOmega(double H0, double Omega0, double tol_M_ncdm) const;
331
332 // Compute dq[i] = w_bg_[i] / f0(q_bg_[i]) for decay_dr species.
333 // Must be called after InitQuadrature (i.e., at end of subclass constructor).
334 std::vector<double> ComputeDq() const;
335
336 // ── Quadrature — perturbation sampling ───────────────────────────────────
337 std::vector<double> q_;
338 std::vector<double> w_;
339 std::vector<double> dlnf0_dlnq_;
349 double dlnf0_dlnq_cut_ = 0.;
354
355 // ── Quadrature — background sampling ─────────────────────────────────────
356 std::vector<double> q_bg_;
357 std::vector<double> w_bg_;
358
359 double factor_ = 0.;
360
361 // ── Species thermodynamic parameters ─────────────────────────────────────
362 double m_in_eV_ = 0.;
363 double M_ = 0.; // dimensionless mass: m / (k_B * T_ncdm)
364 double deg_ = 1.;
365 double T_ = 0.71611; // T_ncdm / T_cmb
366 double ksi_ = 0.; // mu / T_ncdm
367
368 const BackgroundModule* bgm_ = nullptr;
369 double T_cmb_ = 0.;
370 double h_ = 0.;
371
372 private:
373 const perturbs* ppt_ = nullptr;
374
375 struct DistributionParams {
376 const NCDMBaseSpecies* sp = nullptr;
377 // For file-based PSD interpolation:
378 int tablesize = 0;
379 std::vector<double> q, f0, d2f0;
380 int last_index = 0;
381 };
382
383 void ReadParametersByInstance(FileContent* pfc,
384 const std::string& instance_name,
385 const NcdmSettings& settings);
386 void InitDistribution(FileContent* pfc, int species_index);
387
388 void ComputeMomentaMass(double M,
389 double z,
390 double* n,
391 double* rho,
392 double* p,
393 double* drho_dM,
394 double* pseudo_p) const;
395
396 static void DistributionFunction(DistributionParams* p, double q, double* f0);
397 static void TestFunction(double q, double* test);
398
399 int quadrature_strategy_ = 0;
400 int input_q_size_ = 5;
401 int input_q_size_bg_ = 5;
402 double qmax_ = 15.;
403 bool got_file_ = false;
404 std::string psd_file_;
405
406 double rho_nu_rel_ = 0.;
407 double Omega0_ = 0.;
408 double omega0_ = 0.;
409};
Definition base_species.h:90
virtual double P(const double *pvecback) const =0
EnergyType
Definition base_species.h:96
virtual double Rho(const double *pvecback) const =0
Definition parser.h:23
Definition ncdm_base_species.h:43
void SetPerturbs(const perturbs *ppt) override
Definition ncdm_base_species.h:197
bool normalise_drivers_
Definition ncdm_base_species.h:353
void ContributeTensorGwSource(const BaseSpecies::PerturbLayout &base, double a, const double *y, perturb_workspace *ppw) const override
Definition ncdm_base_species.cpp:922
double DeviationFromRadiation(const double *pvecback) const override
Definition ncdm_base_species.h:185
double GetT() const
Definition ncdm_base_species.h:95
double TensorMasslessRelativisticRho(const double *pvecback) const override
Definition ncdm_base_species.h:182
void MarkUsedInSources(const BaseSpecies::PerturbLayout &base, const perturb_workspace *ppw, int *used_in_sources) const override
Definition ncdm_base_species.cpp:756
virtual void FillQuadratureParams(GBQuadParams &) const
Definition ncdm_base_species.h:289
double NeffContribution(double z) const override
Definition ncdm_base_species.h:179
void ApplyTensorInitialConditions(const BaseSpecies::PerturbLayout &base, double *y, double f0, const double *pvecback) const override
Definition ncdm_base_species.cpp:903
bool ClustersAsMatter() const override
Definition ncdm_base_species.h:125
virtual double EvaluatePsdAnalytic(double q) const
Definition ncdm_base_species.cpp:320
virtual double GetW0ForGwSource(int iq, const double *pvecback) const
Definition ncdm_base_species.cpp:892
double BackgroundDensityOverH0Sq(double a, double H0) const override
Definition ncdm_base_species.cpp:955
std::unique_ptr< BaseSpecies::PerturbLayout > CreatePerturbLayout() const override
Definition ncdm_base_species.h:81
double NeutrinoOmega0() const override
Definition ncdm_base_species.h:176
void RegisterTransferSourceIndices(int &index_tp, const SourceRequestContext &ctx) override
Definition ncdm_base_species.cpp:949
bool UsesPsdFile() const
Definition ncdm_base_species.h:105
double BackgroundAIni(double a_proposed, double tol) const override
Definition ncdm_base_species.h:135
void WarnIfNonlinearUnreliable(double m_ev_threshold) const override
Definition ncdm_base_species.cpp:686
void CopyPerturbationsAcrossSwitch(const BaseSpecies::PerturbLayout &old_base, const BaseSpecies::PerturbLayout &new_base, const double *old_y, double *new_y, const PerturbSwitchContext &ctx) const override
Definition ncdm_base_species.cpp:819
int l_max_input_
Definition ncdm_base_species.h:262
void SetLMaxInput(int l_max)
Definition ncdm_base_species.h:57
bool IsColdMatterSpecies() const override
Definition ncdm_base_species.h:128
double rho_nu_rel() const
Definition ncdm_base_species.h:117
virtual double GetDlnf0Dlnq(int iq, const double *pvecback) const =0
int LMax(const precision *ppr) const
Definition ncdm_base_species.h:53
double dlnf0_dlnq_cut_
Definition ncdm_base_species.h:349
bool HasNcdm() const override
Definition ncdm_base_species.h:62
void BuildQuadratureAndMass(const NcdmSettings &settings)
Definition ncdm_base_species.cpp:56
void PerturbTensorDerivs(const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
Definition ncdm_base_species.cpp:846
std::vector< double > FreeStreamingWavenumbers() const override
Definition ncdm_base_species.cpp:702
int MaxMultipole(const precision *ppr, bool) const override
Definition ncdm_base_species.h:47
void PerturbSynchronousToNewtonian(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition ncdm_base_species.cpp:781
void PrintNeffInfo() const override
Definition ncdm_base_species.cpp:666
double GetOmega0() const override
Definition ncdm_base_species.cpp:575
void SetBackgroundModule(const BackgroundModule *bgm) override
Definition ncdm_base_species.h:194
double GetKsi() const
Definition ncdm_base_species.h:100
void PrintMassInfo() const override
Definition ncdm_base_species.cpp:680
virtual quadrature_method DefaultQuadratureStrategy() const
Definition ncdm_base_species.h:284
Definition ncdm_base_species.h:301
Definition perturbations.h:253
Definition perturbations.h:347
Definition perturbations.h:99
Definition base_species.h:106
Definition quadrature.h:31
Definition ncdm_base_species.h:72
Definition perturb_source_context.h:125
Definition perturb_source_context.h:161
Definition perturb_source_context.h:48
Definition perturbations_module.h:380
Definition precision.h:79
int l_max_ncdm
Definition precision.h:470