CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
dncdm_species.h
1#pragma once
2#include <cmath>
3#include <memory>
4#include <optional>
5#include <string_view>
6#include <tuple>
7#include <utility>
8#include <vector>
9
10#include "../species/ncdm_base_species.h"
11#include "../species/species_build_context.h"
12#include "background.h"
13#include "perturbations.h"
14
15class BackgroundModule;
16
23 public:
24 static constexpr std::string_view kTypeName = "ncdm_decay_dr";
25
26 // Reads all DNCDM-specific parameters from the dot-syntax instance
27 // identified by instance_name (e.g. "dncdm1").
29 const std::string& instance_name,
30 const NcdmSettings& settings,
31 const background* pba,
32 const BackgroundModule* bgm);
33
34 // Accessors for deferred closure (used by CreateAll after construction)
35 const std::optional<double>& Omega_ini_pending() const {
36 return Omega_ini_pending_;
37 }
38 const std::optional<double>& Neff_ini_pending() const {
39 return Neff_ini_pending_;
40 }
42 const std::optional<double>& Omega_dncdmdr_reserve() const {
43 return Omega_dncdmdr_reserve_;
44 }
45 const std::optional<double>& Omega_dncdmdr_pending() const {
46 return Omega_dncdmdr_pending_;
47 }
48
54 void BackfillOmega0FromToday(const double* pvecback_today, double H0, double h) {
55 SetOmega0(Rho(pvecback_today) / (H0 * H0), h);
56 }
57
58 // Compute a (deg_guess, dxdy) pair for Newton shooting that varies deg to hit
59 // a target today-density Omega_target = (rho_dncdm + rho_dr) / H0^2 at z=0.
60 // Ported from input_module.cpp:3759-3800 (single-flavor, no loop).
61 std::pair<double, double> DegGuessFromOmegaToday(const SpeciesBuildContext& ctx,
62 double Omega_target) const;
63
64 struct Named {
65 std::string key;
66 std::unique_ptr<DNCDMSpecies> species;
67 };
68
69 static std::vector<Named> CreateAll(const SpeciesBuildContext& ctx);
70
71 // ── Collision-owned mode (DNCDMInvSpecies composite, design §3 table) ─────
72 // When true, the parent drops its ln f + separate-dlnfdlnq integration
73 // variables for a single f-per-bin variable and its background RHS becomes a
74 // no-op; the composite writes the kernel-supplied RHS into the f-slots. Every
75 // background column and the entire perturbation surface are unchanged (both
76 // modes publish index_bg_lnf_decay_dr1_ / index_bg_dlnfdlnq_decay_). Decay-only
77 // runs never set this, so their code path is byte-for-byte unchanged.
78 void SetCollisionOwned(bool v) {
79 collision_owned_ = v;
80 }
81 int bi_f_parent_index() const {
82 return index_bi_f_parent_;
83 }
84
85 // ── Background ──────────────────────────────────────────────────────────
86 void RegisterBackgroundIndices(int& index_bg) override;
87 void RegisterIntegrationIndices(int& index_bi) override;
89 void ComputeBackground(double a, const double* pvecback_B, double* pvecback) override;
90 void BackgroundDerivs(double tau, const double* y, double* dy, const double* pvecback) override;
91
92 double Rho(const double* pvecback) const override {
93 return pvecback[index_bg_rho_];
94 }
95 double P(const double* pvecback) const override {
96 return pvecback[index_bg_p_];
97 }
98 double PPrime(double a,
99 double H,
100 const double* /*pvecback_B*/,
101 const double* pvecback) const override {
102 return a * H * (pvecback[index_bg_pseudo_p_] - 5. * pvecback[index_bg_p_]);
103 }
104
105 // ── Perturbations ────────────────────────────────────────────────────────
106
107 // Layout-based scalar register (writes both layout and legacy pv arrays).
108 void RegisterPerturbationIndices(BaseSpecies::PerturbLayout& base,
109 perturb_vector* pv,
110 const precision* ppr,
111 int& index_pt,
112 const perturb_workspace* ppw,
113 int gauge) override;
114
115 // Scalar PerturbDerivs (called by DNCDM_DR_Species composite with my.dncdm).
117 double tau,
118 const double* y,
119 double* dy,
120 const perturb_parameters_and_workspace& ppaw) const override;
121
123 double* y,
124 const PerturbIcContext& ctx) override;
125
129 StressEnergyContribution StressEnergy(const BaseSpecies::PerturbLayout& base,
130 const perturb_vector* pv,
131 const double* y,
132 const double* pvecback,
133 const perturb_workspace* ppw) const override;
134
140 void FillSources(const BaseSpecies::PerturbLayout& layout,
141 const double* y,
142 const double* dy,
143 PerturbSourceContext& ctx) const override;
145 PerturbColumnWriter& writer,
146 const PerturbationsModule& mod,
147 file_format fmt,
148 TransferColumnSection section = TransferColumnSection::all) const override;
149
150 bool IsFreestreaming() const override {
151 return true;
152 }
154 void WriteBackgroundData(const double* pvecback, BackgroundColumnWriter& w) const override;
155
156 // ── Accessors for DNCDM_DR_Species coupling ───────────────────────────────
157 int bg_number_index() const {
158 return index_bg_number_;
159 }
160 int bg_pseudo_p_index() const {
161 return index_bg_pseudo_p_;
162 }
163 int bg_lnf_index() const {
164 return index_bg_lnf_decay_dr1_;
165 }
166 int bg_dlnfdlnq_index() const {
167 return index_bg_dlnfdlnq_decay_;
168 }
169 int bg_dlnfdlnq_sep_index() const {
170 return index_bg_dlnfdlnq_sep_;
171 }
172 int bi_lnf_index() const {
173 return index_bi_lnf_decay_dr1_;
174 }
175 int bi_dlnfdlnq_sep_index() const {
176 return index_bi_dlnfdlnq_separate_decay_;
177 }
178
179 double Gamma() const {
180 return Gamma_;
181 }
182 const std::vector<double>& dq() const {
183 return dq_;
184 }
185 double GetMass() const {
186 return M_;
187 }
188 const std::vector<double>& GetQ() const {
189 return q_;
190 }
191
192 // Override GetRescaledParameters to use dq_ (not standard w_ weights)
193 std::tuple<double, double> GetRescaledParameters(double a,
194 const double* lnf_array) const override;
195
211 std::tuple<double, double, double> RescaledPerturbations(
212 const NCDMBaseSpecies::PerturbLayout& layout,
213 double a,
214 double k,
215 const double* y,
216 const perturb_workspace* ppw) const;
217
218 protected:
219 // With the cut of a grid that stops at q_max on the last node (dlnf0_dlnq_cut_).
220 double GetDlnf0Dlnq(int iq, const double* pvecback) const override {
221 return pvecback[index_bg_dlnfdlnq_decay_ + iq] + (iq == q_size() - 1 ? dlnf0_dlnq_cut_ : 0.);
222 }
223 double GetW0ForGwSource(int iq, const double* pvecback) const override {
224 return dq_[iq] * std::exp(pvecback[index_bg_lnf_decay_dr1_ + iq]);
225 }
226
227 private:
228 const background* pba_;
229
230 // Deferred closure stash (instance-name constructor only).
231 // Set when the user specifies Omega_ini/omega_ini or Neff_ini; CreateAll
232 // applies SetDeg_from_Omega_ini once a_ini is available.
233 std::optional<double> Omega_ini_pending_;
234 std::optional<double> Neff_ini_pending_;
235 // Today-density target: shoot deg so that (rho_dncdm+rho_dr)/H0^2 == this value at z=0.
236 std::optional<double> Omega_dncdmdr_pending_;
237 std::optional<double> Omega_dncdmdr_reserve_;
238
239 // Absorbed from DecayDRProperties
240 double Gamma_ = 0.;
241 std::vector<double> dq_;
242
243 // Collision-owned mode (set by the DNCDMInvSpecies factory before any index
244 // registration). kFParentFloor keeps ln f defined as gains repopulate f from 0.
245 // In this mode the perturbation state variable is F = δf, not the normalized Ψ
246 // (#386) — see PerturbDerivs / RescaledPerturbations.
247 bool collision_owned_ = false;
257 static constexpr double kFParentFloor = 1e-100;
258 // Set from STORED table rows only (BackgroundModule::StoringBackgroundTable) --
259 // never from the evolver's trial states, which are allowed to be unphysical.
260 // See FloorReport.
261 mutable bool floor_touched_ = false;
262 mutable bool floor_left_ = false;
263 mutable bool negative_f_rows_ = false;
264
265 public:
288 static constexpr double kFScale = 1e150;
289
310 struct FloorReport {
311 bool touched = false;
312 bool left = false;
313 bool negative = false;
314 };
315 FloorReport BackgroundFloorReport() const {
316 return {floor_touched_, floor_left_, negative_f_rows_};
317 }
318
319 private:
320 // Background indices
321 int index_bg_number_ = -1;
322 int index_bg_pseudo_p_ = -1;
323
324 int index_bi_lnf_decay_dr1_ = -1;
325 int index_bi_dlnfdlnq_separate_decay_ = -1;
326 int index_bi_f_parent_ = -1; // collision-owned: single f-per-bin variable
327
328 int index_bg_lnf_decay_dr1_ = -1;
329 int index_bg_dlnfdlnq_decay_ = -1;
330 int index_bg_dlnfdlnq_sep_ = -1;
331};
Definition base_species.h:33
Definition dncdm_species.h:22
const std::optional< double > & Omega_dncdmdr_reserve() const
Definition dncdm_species.h:42
void BackfillOmega0FromToday(const double *pvecback_today, double H0, double h)
Definition dncdm_species.h:54
void FillSources(const BaseSpecies::PerturbLayout &layout, const double *y, const double *dy, PerturbSourceContext &ctx) const override
Definition dncdm_species.cpp:865
double PPrime(double a, double H, const double *, const double *pvecback) const override
Definition dncdm_species.h:98
void WriteBackgroundData(const double *pvecback, BackgroundColumnWriter &w) const override
Definition dncdm_species.cpp:577
std::tuple< double, double, double > RescaledPerturbations(const NCDMBaseSpecies::PerturbLayout &layout, double a, double k, const double *y, const perturb_workspace *ppw) const
Definition dncdm_species.cpp:923
void WriteBackgroundColumnTitles(BackgroundColumnWriter &w) const override
Definition dncdm_species.cpp:564
void SetBackgroundInitialConditions(const BackgroundICContext &ctx) override
Definition dncdm_species.cpp:366
double GetDlnf0Dlnq(int iq, const double *pvecback) const override
Definition dncdm_species.h:220
static constexpr double kFScale
Definition dncdm_species.h:288
void RegisterIntegrationIndices(int &index_bi) override
Definition dncdm_species.cpp:353
StressEnergyContribution StressEnergy(const BaseSpecies::PerturbLayout &base, const perturb_vector *pv, const double *y, const double *pvecback, const perturb_workspace *ppw) const override
Definition dncdm_species.cpp:797
double Rho(const double *pvecback) const override
Definition dncdm_species.h:92
void WriteOutputColumns(PerturbColumnWriter &writer, const PerturbationsModule &mod, file_format fmt, TransferColumnSection section=TransferColumnSection::all) const override
Definition dncdm_species.cpp:907
bool IsFreestreaming() const override
Definition dncdm_species.h:150
void PerturbDerivs(const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
Definition dncdm_species.cpp:616
void RegisterBackgroundIndices(int &index_bg) override
Definition dncdm_species.cpp:339
void BackgroundDerivs(double tau, const double *y, double *dy, const double *pvecback) override
Definition dncdm_species.cpp:543
double P(const double *pvecback) const override
Definition dncdm_species.h:95
void ComputeBackground(double a, const double *pvecback_B, double *pvecback) override
Definition dncdm_species.cpp:386
double GetW0ForGwSource(int iq, const double *pvecback) const override
Definition dncdm_species.h:223
void ApplyInitialConditions(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition dncdm_species.cpp:758
Definition dncdm_species.h:310
Definition parser.h:23
Definition ncdm_base_species.h:43
double dlnf0_dlnq_cut_
Definition ncdm_base_species.h:349
Definition perturb_source_context.h:63
Definition perturbations.h:253
Definition perturbations.h:347
file_format
Definition precision.h:56
Definition background_ic_context.h:11
Definition base_species.h:106
Definition ncdm_base_species.h:72
Definition species_build_context.h:92
Definition perturb_source_context.h:125
Definition perturb_source_context.h:103
Definition species_build_context.h:58
Definition perturbations_module.h:380
Definition precision.h:79