CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
dncdm_inv_species.h
1#pragma once
2#include <memory>
3#include <vector>
4
5#include "background.h"
6#include "composite_species.h"
7#include "decay_transition_kernel.h"
8#include "dncdm_sector.h"
9#include "dncdm_species.h"
10#include "dr_psd_species.h"
11#include "reduced_collision_operator.h"
12#include "species/shooting_target.h"
13#include "species/species_build_context.h"
14
15class BackgroundModule;
16
47 public:
49 bool HasNcdm() const override {
50 return true;
51 }
52
53 enum ChildIndex { kParent = 0, kFermion = 1, kBoson = 2 }; // children_ order
54
55 static const NCDMBaseSpecies::PerturbLayout& parent_layout(const BaseSpecies::PerturbLayout& my) {
56 return static_cast<const NCDMBaseSpecies::PerturbLayout&>(
57 *static_cast<const CompositeSpecies::PerturbLayout&>(my).child_layouts[kParent]);
58 }
59 static const NCDMBaseSpecies::PerturbLayout& fermion_layout(
61 return static_cast<const NCDMBaseSpecies::PerturbLayout&>(
62 *static_cast<const CompositeSpecies::PerturbLayout&>(my).child_layouts[kFermion]);
63 }
64 static const NCDMBaseSpecies::PerturbLayout& boson_layout(const BaseSpecies::PerturbLayout& my) {
65 return static_cast<const NCDMBaseSpecies::PerturbLayout&>(
66 *static_cast<const CompositeSpecies::PerturbLayout&>(my).child_layouts[kBoson]);
67 }
68
69 DNCDMInvSpecies(std::unique_ptr<DNCDMSpecies> parent,
70 std::unique_ptr<DrPsdSpecies> fermion,
71 std::unique_ptr<DrPsdSpecies> boson,
72 DecayTransitionKernel::Config cfg,
73 const background* pba,
74 const BackgroundModule* bgm);
75
80 static Named Create(std::unique_ptr<DNCDMSpecies> parent, const SpeciesBuildContext& ctx);
81
82 DNCDMSpecies& parent() {
83 return *parent_;
84 }
85 DrPsdSpecies& fermion() {
86 return *fermion_;
87 }
88 DrPsdSpecies& boson() {
89 return *boson_;
90 }
91
92 // (2*pi)^3, as a compile-time constant: KappaStoredToBare is called every
93 // background/perturbation RHS evaluation (hot path), so the folding must not
94 // depend on whether the compiler treats pow(2*_PI_, 3) as constant-foldable.
95 static constexpr double kTwoPiCubed = 8. * _PI_ * _PI_ * _PI_;
96
103 double KappaStoredToBare() const {
104 return parent_->GetDeg() * kTwoPiCubed / 2.;
105 }
106
107 // ── Background ─────────────────────────────────────────────────────────────
108 void SetBackgroundModule(const BackgroundModule* bgm) override;
109 void BackgroundDerivs(double tau, const double* y, double* dy, const double* pvecback) override;
110
115 void BackgroundDerivsDiagonal(double tau,
116 const double* y,
117 double* diag,
118 const double* pvecback) override;
119
123 void ApplyKernelBackgroundDerivs(double a,
124 const double* y,
125 double* dy,
126 double a_prime_over_a = 0.);
127
129 void WriteBackgroundData(const double* pvecback, BackgroundColumnWriter& w) const override;
130
131 // ── Perturbations: the per-ℓ collision coupling (design §4.3) ───────────────
137 void AddCouplingDerivs(double tau,
138 const double* y,
139 double* dy,
140 const perturb_parameters_and_workspace& ppaw) const override;
141
157 std::unique_ptr<DecayTransitionKernel> kernel_pt;
158 std::vector<double> fH_gather;
159 std::vector<double> F_H, F_l, F_phi;
160 std::vector<double> dF_H, dF_l, dF_phi;
164 std::vector<double> dy_coll;
169 std::vector<double> diag_H_pt, diag_l_pt, diag_phi_pt;
173 std::vector<double> FH_all, Fl_all, Fphi_all, dFH_all, dFl_all, dFphi_all;
177 std::vector<double> red_m, red_grid;
179 std::vector<double> red_z, red_dz;
180 };
181 std::unique_ptr<BaseSpecies::PerturbScratch> CreatePerturbScratch() const override;
182
189 void ApplyKernelPerturbDerivs(double a,
190 int l_max_col,
191 const double* pvecback,
195 const double* y,
196 double* dy,
197 Scratch& scratch,
198 double k = 0.) const;
199
211 void ApplyKernelPerturbDiagonal(double a,
212 int l_max_col,
213 const double* pvecback,
217 double* diag,
218 Scratch& scratch) const;
219
221 double tau,
222 const double* y,
223 double* diag,
224 const perturb_parameters_and_workspace& ppaw) const override;
225
229 void ProcessBackgroundTable(const double* background_table,
230 int n_rows,
231 int row_stride,
232 const double* z_table) override;
233
237 reduced_moments_ = n;
238 }
239 int reduced_moments() const {
240 return reduced_moments_;
241 }
245 bool reduced() const {
246 return reduced_moments_ > 0 && reduced_op_ != nullptr;
247 }
248 void set_reduced_table_l_max(int l) {
249 reduced_table_l_max_ = l;
250 }
309 static constexpr double kTableMaxDlnaDefault = 7e-3;
310
314 static constexpr double kTableDefaultValidatedTo = 1e9;
315
318 void set_table_max_dlna(double dlna) {
319 table_max_dlna_ = dlna;
320 }
334 bool tabulated() const {
335 return reduced() && !reduced_table_.empty();
336 }
337
344 const BaseSpecies::PerturbLayout* base,
345 double tau,
346 const double* y,
347 const PerturbationsModule& mod,
348 const perturb_workspace* ppw) const override;
349
350 // ── Test introspection (not on the hot path) ───────────────────────────────
358 const std::vector<double>& KernelDfBgH(const Scratch& scratch) const {
359 return scratch.kernel_pt->df_bg_H();
360 }
361
362 // ── Test introspection (not on the hot path) ───────────────────────────────
371 DecayTransitionKernel::Moments ConservationMoments(double a, const double* dy) const;
373 double ClampedEnergyResidual() const {
374 return kernel_->clamped_energy_residual();
375 }
380 double SplitEnergyResidual() const {
381 return kernel_->split_energy_residual();
382 }
386 double SplitEnergyResidualPert(const Scratch& scratch) const {
387 return scratch.kernel_pt->split_energy_residual_pert();
388 }
389 double SplitMomentumResidualPert(const Scratch& scratch) const {
390 return scratch.kernel_pt->split_momentum_residual_pert();
391 }
395 double ClampedEnergyResidualPert(const Scratch& scratch) const {
396 return scratch.kernel_pt->clamped_energy_residual();
397 }
398
399 protected:
400 double DaughtersInitialRadiationOmega0(double H0) const override;
401 bool HasInverseDecays() const override {
402 return cfg_.inverse_decays;
403 }
404
405 private:
417 void BuildReducedBasis(const double* background_table, int n_rows, int row_stride);
418
431 void BuildReducedTable(const double* background_table, int n_rows, int row_stride);
432
439 static constexpr double kTableActiveRate = 1e-4;
440
454 static constexpr double kTableDlnaSlack = 0.01;
455
464 DNCDMSpecies* parent_ = nullptr;
465 DrPsdSpecies* fermion_ = nullptr;
466 DrPsdSpecies* boson_ = nullptr;
467 int reduced_moments_ = 0;
471 int background_verbose_ = 0;
477 bool emit_l_moments_ = false;
478
483 static constexpr int kLMomentMax = 20;
488 std::unique_ptr<ReducedCollisionOperator> reduced_op_;
494 std::unique_ptr<DecayTransitionKernel> reduced_basis_kernel_;
501 int reduced_table_l_max_ = -1;
504 double table_max_dlna_ = kTableMaxDlnaDefault;
507 ReducedOperatorTable reduced_table_;
508 // TWO kernel instances over the SAME parent grid and the same Config, differing
509 // only in which daughter grids they see. The daughters' background grid must stay
510 // fine (it resolves the decay-injection band and carries the exact number/energy
511 // conservation of the background RHS), while the perturbation hierarchy has to be
512 // able to run on a coarser grid — N_pt·(l_max+1) variables per k-mode per daughter
513 // is the whole cost of a run. Two instances rather than one parameterized kernel
514 // because DecayTransitionKernel binds its grids (and all its per-node scratch) at
515 // construction; it is deliberately left untouched.
516 std::unique_ptr<DecayTransitionKernel> kernel_; // daughters at q_bg()/dq_bg()
517 // Kernel Config, kept so CreatePerturbScratch can build the per-k perturbation
518 // kernels. There is deliberately NO shared perturbation kernel member: the only
519 // instances live in per-workspace Scratch, so a racy one cannot be reached.
520 DecayTransitionKernel::Config cfg_;
521 std::vector<double> df_H_, df_l_, df_phi_; // background hot-path scratch (sized in ctor)
522 // Same, for BackgroundDerivsDiagonal. Separate from df_* because the evolver may
523 // want both at one state and reusing the buffers would make the order load-bearing.
524 std::vector<double> diag_H_, diag_l_, diag_phi_;
525 // Parent-only kernel-boundary scratch (#385): fH_bare_[i] = kappa * y[parent slot
526 // i], the bare occupation ApplyKernelBackgroundDerivs hands to kernel_ in place
527 // of the raw (stored) f-slot pointer. Ctor-sized (parent q_size), never resized.
528 std::vector<double> fH_bare_;
529
530 const background* pba_ = nullptr;
531 const BackgroundModule* bgm_ = nullptr;
532};
Definition base_species.h:33
Definition dncdm_inv_species.h:46
void BackgroundDerivsDiagonal(double tau, const double *y, double *diag, const double *pvecback) override
Definition dncdm_inv_species.cpp:542
void ApplyKernelBackgroundDerivs(double a, const double *y, double *dy, double a_prime_over_a=0.)
Definition dncdm_inv_species.cpp:483
void WriteBackgroundColumnTitles(BackgroundColumnWriter &w) const override
Definition dncdm_inv_species.cpp:1537
static Named Create(std::unique_ptr< DNCDMSpecies > parent, const SpeciesBuildContext &ctx)
Definition dncdm_inv_species.cpp:63
void AddCouplingDerivs(double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
Definition dncdm_inv_species.cpp:1464
double SplitEnergyResidual() const
Definition dncdm_inv_species.h:380
void ProcessBackgroundTable(const double *background_table, int n_rows, int row_stride, const double *z_table) override
Definition dncdm_inv_species.cpp:1052
void BackgroundDerivs(double tau, const double *y, double *dy, const double *pvecback) override
Definition dncdm_inv_species.cpp:530
void WriteBackgroundData(const double *pvecback, BackgroundColumnWriter &w) const override
Definition dncdm_inv_species.cpp:1544
void set_table_max_dlna(double dlna)
Definition dncdm_inv_species.h:318
void ApplyKernelPerturbDerivs(double a, int l_max_col, const double *pvecback, const NCDMBaseSpecies::PerturbLayout &p_lay, const NCDMBaseSpecies::PerturbLayout &f_lay, const NCDMBaseSpecies::PerturbLayout &b_lay, const double *y, double *dy, Scratch &scratch, double k=0.) const
Definition dncdm_inv_species.cpp:1111
void PrintVariables(PerturbColumnWriter &writer, const BaseSpecies::PerturbLayout *base, double tau, const double *y, const PerturbationsModule &mod, const perturb_workspace *ppw) const override
Definition dncdm_inv_species.cpp:1570
bool tabulated() const
Definition dncdm_inv_species.h:334
bool HasNcdm() const override
Definition dncdm_inv_species.h:49
void PerturbDerivsDiagonal(const BaseSpecies::PerturbLayout &layout, double tau, const double *y, double *diag, const perturb_parameters_and_workspace &ppaw) const override
Definition dncdm_inv_species.cpp:1499
DecayTransitionKernel::Moments ConservationMoments(double a, const double *dy) const
Definition dncdm_inv_species.cpp:591
void set_reduced_moments(int n)
Definition dncdm_inv_species.h:236
bool HasInverseDecays() const override
Definition dncdm_inv_species.h:401
bool reduced() const
Definition dncdm_inv_species.h:245
double ClampedEnergyResidual() const
Definition dncdm_inv_species.h:373
void ApplyKernelPerturbDiagonal(double a, int l_max_col, const double *pvecback, const NCDMBaseSpecies::PerturbLayout &p_lay, const NCDMBaseSpecies::PerturbLayout &f_lay, const NCDMBaseSpecies::PerturbLayout &b_lay, double *diag, Scratch &scratch) const
Definition dncdm_inv_species.cpp:1340
double DaughtersInitialRadiationOmega0(double H0) const override
Definition dncdm_inv_species.cpp:1566
double KappaStoredToBare() const
Definition dncdm_inv_species.h:103
const std::vector< double > & KernelDfBgH(const Scratch &scratch) const
Definition dncdm_inv_species.h:358
static constexpr double kTableDefaultValidatedTo
Definition dncdm_inv_species.h:314
static constexpr double kTableMaxDlnaDefault
Definition dncdm_inv_species.h:309
double SplitEnergyResidualPert(const Scratch &scratch) const
Definition dncdm_inv_species.h:386
void SetBackgroundModule(const BackgroundModule *bgm) override
Definition dncdm_inv_species.cpp:474
double ClampedEnergyResidualPert(const Scratch &scratch) const
Definition dncdm_inv_species.h:395
Definition dncdm_sector.h:28
Definition dncdm_species.h:22
Definition dr_psd_species.h:54
Definition perturb_source_context.h:63
#define _PI_
Definition constants.h:7
Definition perturbations.h:347
Definition base_species.h:106
Definition base_species.h:136
Definition composite_species.h:37
Definition dncdm_inv_species.h:156
std::vector< double > FH_all
Definition dncdm_inv_species.h:173
std::vector< double > red_z
Definition dncdm_inv_species.h:179
std::vector< double > diag_H_pt
Definition dncdm_inv_species.h:169
std::vector< double > red_m
Definition dncdm_inv_species.h:177
std::vector< double > dy_coll
Definition dncdm_inv_species.h:164
Definition ncdm_base_species.h:72
Definition species_build_context.h:92
Definition species_build_context.h:58
Definition perturbations_module.h:380