CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
composite_species.h
1#pragma once
2#include <algorithm>
3#include <memory>
4#include <string>
5#include <vector>
6
7#include "base_species.h"
8
28 public:
29 CompositeSpecies(std::string name, EnergyType energy_type)
30 : BaseSpecies(std::move(name), energy_type) {
31 delegates_tally_ = true;
32 }
33
38 std::vector<std::unique_ptr<BaseSpecies::PerturbLayout>> child_layouts;
39 };
40
41 std::unique_ptr<BaseSpecies::PerturbLayout> CreatePerturbLayout() const override;
42
43 void RegisterPerturbationIndices(BaseSpecies::PerturbLayout& base,
45 const precision* ppr,
46 int& index_pt,
47 const perturb_workspace* ppw,
48 int gauge) override;
50 double* y,
51 const PerturbIcContext& ctx) override;
53 const perturb_vector* pv,
54 const double* y,
55 const double* pvecback,
56 const perturb_workspace* ppw) const override;
57 void DelegateTally(const BaseSpecies::PerturbLayout& base,
58 const perturb_vector* pv,
59 const double* y,
60 const double* pvecback,
61 const perturb_workspace* ppw,
63 StressEnergyContribution& total_cold,
64 StressEnergyContribution& total_warm) const override;
66 double tau,
67 const double* y,
68 double* dy,
69 const perturb_parameters_and_workspace& ppaw) const override;
71 double tau,
72 const double* y,
73 double* diag,
74 const perturb_parameters_and_workspace& ppaw) const override;
76 const double* y,
77 const double* dy,
78 PerturbSourceContext& ctx) const override;
86 PerturbColumnWriter& writer,
87 const PerturbationsModule& mod,
88 file_format fmt,
89 TransferColumnSection section = TransferColumnSection::all) const override;
95 double tau,
96 const double* y,
97 const PerturbationsModule& mod,
98 const perturb_workspace* ppw) const override;
99
101 double* y,
102 const PerturbIcContext& ctx) override;
104 const BaseSpecies::PerturbLayout& new_base,
105 const double* old_y,
106 double* new_y,
107 const PerturbSwitchContext& ctx) const override;
108
109 // ── Registration ────────────────────────────────────────────────────────
110 void RegisterBackgroundIndices(int& index_bg) override;
111 void RegisterIntegrationIndices(int& index_bi) override;
112 void RegisterTransferSourceIndices(int& index_tp, const SourceRequestContext& ctx) override;
113 // ── Omega0 (closure) ────────────────────────────────────────────────────
115 double GetOmega0() const override {
116 double sum = 0.0;
117 for (const auto& c : children_) {
118 sum += c->GetOmega0();
119 }
120 return sum;
121 }
122
126 void AppendBudgetLines(const double* pvecback_today,
127 double rho_crit,
128 std::vector<BudgetLine>& out) const {
129 for (const auto& c : children_) {
130 out.push_back({c->name(), c->Rho(pvecback_today) / rho_crit, BudgetBucketOf(*c)});
131 }
132 }
133
138 for (const auto& c : children_) {
139 if (!c->SupportsExplicitPerturbationEvolver()) {
140 return false;
141 }
142 }
143 return true;
144 }
145
149 int MaxMultipole(const precision* ppr, bool tensors) const override {
150 int l_max = 0;
151 for (const auto& c : children_) {
152 l_max = std::max(l_max, c->MaxMultipole(ppr, tensors));
153 }
154 return l_max;
155 }
156
161 for (const auto& c : children_) {
162 if (c->PrefersExponentialPerturbationEvolver()) {
163 return true;
164 }
165 }
166 return false;
167 }
168
173 for (const auto& c : children_) {
174 if (!c->SupportsExponentialPerturbationEvolver()) {
175 return false;
176 }
177 }
178 return true;
179 }
180
183 double GetRadiationOmega0() const override {
184 double sum = 0.0;
185 for (const auto& c : children_) {
186 sum += c->GetRadiationOmega0();
187 }
188 return sum;
189 }
190
192 double DarkRadiationRhoToday(const double* pvecback_integration) const override {
193 double sum = 0.0;
194 for (const auto& c : children_) {
195 sum += c->DarkRadiationRhoToday(pvecback_integration);
196 }
197 return sum;
198 }
199
201 double NeutrinoOmega0() const override {
202 double sum = 0.0;
203 for (const auto& c : children_) {
204 sum += c->NeutrinoOmega0();
205 }
206 return sum;
207 }
208
210 double NeffContribution(double z) const override {
211 double sum = 0.0;
212 for (const auto& c : children_) {
213 sum += c->NeffContribution(z);
214 }
215 return sum;
216 }
217
218 void PrintNeffInfo() const override {
219 for (const auto& c : children_) {
220 c->PrintNeffInfo();
221 }
222 }
223 void PrintMassInfo() const override {
224 for (const auto& c : children_) {
225 c->PrintMassInfo();
226 }
227 }
228 void PrintBackgroundDetails(const double* pvecback_today, double rho_crit_today) const override {
229 for (const auto& c : children_) {
230 c->PrintBackgroundDetails(pvecback_today, rho_crit_today);
231 }
232 }
233
234 double TensorMasslessRelativisticRho(const double* pvecback) const override {
235 double sum = 0.0;
236 for (const auto& c : children_) {
237 sum += c->TensorMasslessRelativisticRho(pvecback);
238 }
239 return sum;
240 }
241 double DeviationFromRadiation(const double* pvecback) const override {
242 double deviation = 0.;
243 for (const auto& c : children_) {
244 deviation = std::max(deviation, c->DeviationFromRadiation(pvecback));
245 }
246 return deviation;
247 }
248 void WarnIfNonlinearUnreliable(double m_ev_threshold) const override {
249 for (const auto& c : children_) {
250 c->WarnIfNonlinearUnreliable(m_ev_threshold);
251 }
252 }
253 std::vector<double> FreeStreamingWavenumbers() const override {
254 std::vector<double> k_fs;
255 for (const auto& c : children_) {
256 const std::vector<double> child = c->FreeStreamingWavenumbers();
257 k_fs.insert(k_fs.end(), child.begin(), child.end());
258 }
259 return k_fs;
260 }
261
263 std::optional<double> ChildOmega0(const std::string& name) const override {
264 for (const auto& c : children_) {
265 if (c->name() == name) {
266 return c->GetOmega0();
267 }
268 }
269 return std::nullopt;
270 }
271
274 double BackgroundAIni(double a_proposed, double tol) const override {
275 for (const auto& c : children_) {
276 a_proposed = c->BackgroundAIni(a_proposed, tol);
277 }
278 return a_proposed;
279 }
280
281 // ── Background ──────────────────────────────────────────────────────────
282 void SetBackgroundModule(const BackgroundModule* bgm) override;
283 void SetThermodynamicsModule(const ThermodynamicsModule* thm) override;
284 void SetPerturbs(const perturbs* ppt) override;
285 void SetBackgroundInitialConditions(const BackgroundICContext& ctx) override;
286 void ComputeBackground(double a, const double* pvecback_B, double* pvecback) override;
287 void BackgroundDerivs(double tau, const double* y, double* dy, const double* pvecback) override;
288 void BackgroundDerivsDiagonal(double tau,
289 const double* y,
290 double* diag,
291 const double* pvecback) override;
292 void FinalizeBackground(double a, double H, const double* pvecback_B, double* pvecback) override;
293 double Rho(const double* pvecback) const override;
294 double P(const double* pvecback) const override;
295 double PPrime(double a,
296 double H,
297 const double* pvecback_B,
298 const double* pvecback) const override;
299 double FreestreamingRho(const double* pvecback) const override;
300
301 // ── Matter tally ────────────────────────────────────────────────────────
302 bool ClustersAsMatter() const override;
303 bool IsColdMatterSpecies() const override;
304 bool HasWarmMatter() const override;
305 double NonClusteringOmega0() const override;
306 double ColdMatterRho(const double* pvecback) const override;
307 double ColdMatterOmega0() const override;
308 void FinalizeMatterClassification() override;
309
310 protected:
311 std::vector<std::unique_ptr<BaseSpecies>> children_;
312
318 virtual void AddCouplingDerivs(double tau,
319 const double* y,
320 double* dy,
321 const perturb_parameters_and_workspace& ppaw) const;
322};
Definition base_species.h:90
EnergyType
Definition base_species.h:96
Definition composite_species.h:27
bool SupportsExponentialPerturbationEvolver() const override
Definition composite_species.h:172
double P(const double *pvecback) const override
Definition composite_species.cpp:89
void FinalizeBackground(double a, double H, const double *pvecback_B, double *pvecback) override
Definition composite_species.cpp:72
void PrintMassInfo() const override
Definition composite_species.h:223
void RegisterIntegrationIndices(int &index_bi) override
Definition composite_species.cpp:11
std::unique_ptr< BaseSpecies::PerturbLayout > CreatePerturbLayout() const override
Definition composite_species.cpp:116
void PrintVariables(PerturbColumnWriter &writer, const BaseSpecies::PerturbLayout *base, double tau, const double *y, const PerturbationsModule &mod, const perturb_workspace *ppw) const override
Definition composite_species.cpp:226
double ColdMatterOmega0() const override
Definition composite_species.cpp:314
bool SupportsExplicitPerturbationEvolver() const override
Definition composite_species.h:137
void BackgroundDerivs(double tau, const double *y, double *dy, const double *pvecback) override
Definition composite_species.cpp:54
void PerturbSynchronousToNewtonian(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition composite_species.cpp:239
double BackgroundAIni(double a_proposed, double tol) const override
Definition composite_species.h:274
void ApplyInitialConditions(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition composite_species.cpp:137
void PrintBackgroundDetails(const double *pvecback_today, double rho_crit_today) const override
Definition composite_species.h:228
virtual void AddCouplingDerivs(double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const
Definition composite_species.cpp:264
void RegisterTransferSourceIndices(int &index_tp, const SourceRequestContext &ctx) override
Definition composite_species.cpp:17
bool HasWarmMatter() const override
Definition composite_species.cpp:287
double NeutrinoOmega0() const override
Definition composite_species.h:201
void RegisterBackgroundIndices(int &index_bg) override
Definition composite_species.cpp:5
void WarnIfNonlinearUnreliable(double m_ev_threshold) const override
Definition composite_species.h:248
void WriteOutputColumns(PerturbColumnWriter &writer, const PerturbationsModule &mod, file_format fmt, TransferColumnSection section=TransferColumnSection::all) const override
Definition composite_species.cpp:217
double DeviationFromRadiation(const double *pvecback) const override
Definition composite_species.h:241
double NonClusteringOmega0() const override
Definition composite_species.cpp:298
void SetThermodynamicsModule(const ThermodynamicsModule *thm) override
Definition composite_species.cpp:30
void SetBackgroundInitialConditions(const BackgroundICContext &ctx) override
Definition composite_species.cpp:42
bool PrefersExponentialPerturbationEvolver() const override
Definition composite_species.h:160
void BackgroundDerivsDiagonal(double tau, const double *y, double *diag, const double *pvecback) override
Definition composite_species.cpp:63
std::optional< double > ChildOmega0(const std::string &name) const override
Definition composite_species.h:263
int MaxMultipole(const precision *ppr, bool tensors) const override
Definition composite_species.h:149
void PerturbDerivs(const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
Definition composite_species.cpp:181
double ColdMatterRho(const double *pvecback) const override
Definition composite_species.cpp:306
void PrintNeffInfo() const override
Definition composite_species.h:218
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 composite_species.cpp:248
double DarkRadiationRhoToday(const double *pvecback_integration) const override
Definition composite_species.h:192
double PPrime(double a, double H, const double *pvecback_B, const double *pvecback) const override
Definition composite_species.cpp:97
double GetRadiationOmega0() const override
Definition composite_species.h:183
double GetOmega0() const override
Definition composite_species.h:115
double FreestreamingRho(const double *pvecback) const override
Definition composite_species.cpp:108
bool IsColdMatterSpecies() const override
Definition composite_species.cpp:278
bool ClustersAsMatter() const override
Definition composite_species.cpp:269
void FinalizeMatterClassification() override
Definition composite_species.cpp:322
double Rho(const double *pvecback) const override
Definition composite_species.cpp:81
void AppendBudgetLines(const double *pvecback_today, double rho_crit, std::vector< BudgetLine > &out) const
Definition composite_species.h:126
StressEnergyContribution StressEnergy(const BaseSpecies::PerturbLayout &base, const perturb_vector *pv, const double *y, const double *pvecback, const perturb_workspace *ppw) const override
Definition composite_species.cpp:146
void SetPerturbs(const perturbs *ppt) override
Definition composite_species.cpp:36
std::vector< double > FreeStreamingWavenumbers() const override
Definition composite_species.h:253
double TensorMasslessRelativisticRho(const double *pvecback) const override
Definition composite_species.h:234
void FillSources(const BaseSpecies::PerturbLayout &base, const double *y, const double *dy, PerturbSourceContext &ctx) const override
Definition composite_species.cpp:207
double NeffContribution(double z) const override
Definition composite_species.h:210
void SetBackgroundModule(const BackgroundModule *bgm) override
Definition composite_species.cpp:24
void PerturbDerivsDiagonal(const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *diag, const perturb_parameters_and_workspace &ppaw) const override
Definition composite_species.cpp:193
void ComputeBackground(double a, const double *pvecback_B, double *pvecback) override
Definition composite_species.cpp:48
Definition perturb_source_context.h:63
Definition perturbations.h:253
Definition perturbations.h:347
Definition perturbations.h:99
file_format
Definition precision.h:56
Definition background_ic_context.h:11
Definition base_species.h:106
Definition base_species.h:421
Definition composite_species.h:37
Definition perturb_source_context.h:125
Definition perturb_source_context.h:103
Definition perturb_source_context.h:161
Definition perturb_source_context.h:48
Definition perturbations_module.h:380
Definition precision.h:79