CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
scalar_field.h
1#pragma once
2#include <string>
3#include <string_view>
4
5#include "../species/base_species.h"
6#include "background.h"
7#include "perturbations.h"
8#include "scalar_field_potential.h"
9#include "species_build_context.h"
10
11class BackgroundModule;
12
20 public:
21 static constexpr std::string_view kTypeName = "scalar_field";
22
23 ScalarFieldSpecies(const background& pba,
24 double omega0_scf,
25 std::vector<double> scf_parameters,
26 int scf_tuning_index,
27 bool attractor_ic_scf,
28 double phi_ini_scf,
29 double phi_prime_ini_scf,
30 ScalarFieldPotential potential = DefaultScalarFieldPotential(),
31 double beta = 0.,
32 std::string instance_name = {});
33
36 struct InputKeys {
37 std::string instance_name; // empty for the legacy field
38 std::string Omega;
39 std::string potential;
40 std::string parameters;
41 std::string tuning_index;
42 std::string shooting_parameter;
43 std::string attractor_ic;
44 std::string m_axion;
45 std::string f_axion;
46 std::string n_axion;
47 std::string Theta_initial;
48
49 static InputKeys Legacy();
50 static InputKeys Instance(const std::string& name);
51 };
52
53 double GetOmega0() const override {
54 return Omega0_scf_;
55 }
56
57 const std::vector<double>& scf_parameters() const {
58 return scf_parameters_;
59 }
60 int scf_tuning_index() const {
61 return scf_tuning_index_;
62 }
63 bool attractor_ic_scf() const {
64 return attractor_ic_scf_;
65 }
66 double phi_ini_scf() const {
67 return phi_ini_scf_;
68 }
69 double phi_prime_ini_scf() const {
70 return phi_prime_ini_scf_;
71 }
72 double beta() const {
73 return beta_;
74 }
75
76 // ── Background ──────────────────────────────────────────────────────────
77 void SetBackgroundModule(const BackgroundModule* bgm) override {
78 bgm_ = bgm;
79 }
80 void RegisterBackgroundIndices(int& index_bg) override {
81 index_bg_phi_scf_ = index_bg++;
82 index_bg_phi_prime_scf_ = index_bg++;
83 index_bg_V_scf_ = index_bg++;
84 index_bg_dV_scf_ = index_bg++;
85 index_bg_ddV_scf_ = index_bg++;
86 index_bg_rho_ = index_bg++;
87 index_bg_p_ = index_bg++;
88 index_bg_p_prime_scf_ = index_bg++;
89 }
90
91 void RegisterIntegrationIndices(int& index_bi) override {
92 index_bi_phi_scf_ = index_bi++;
93 index_bi_phi_prime_scf_ = index_bi++;
94 }
95
97
98 void ComputeBackground(double a, const double* pvecback_B, double* pvecback) override;
99
100 void BackgroundDerivs(double tau, const double* y, double* dy, const double* pvecback) override;
101
102 double Rho(const double* pvecback) const override {
103 return pvecback[index_bg_rho_];
104 }
105 double P(const double* pvecback) const override {
106 return pvecback[index_bg_p_];
107 }
108
110 void WriteBackgroundData(const double* pvecback, BackgroundColumnWriter& w) const override;
111 void PrintBackgroundDetails(const double* pvecback_today, double rho_crit_today) const override;
112
113 // ── Perturbations ────────────────────────────────────────────────────────
114 struct PerturbLayout : BaseSpecies::PerturbLayout {
115 int idx_phi = -1; // delta_phi
116 // Synchronous: delta_phi'. Newtonian: q = delta_phi' - phi'_bg (psi + 3 phi).
117 int idx_phi_prime = -1;
118 };
119
120 std::unique_ptr<BaseSpecies::PerturbLayout> CreatePerturbLayout() const override {
121 return std::make_unique<PerturbLayout>();
122 }
123
124 void RegisterTransferSourceIndices(int& index_tp, const SourceRequestContext& ctx) override;
125 void RegisterPerturbationIndices(BaseSpecies::PerturbLayout& base,
126 perturb_vector* pv,
127 const precision* ppr,
128 int& index_pt,
129 const perturb_workspace* ppw,
130 int gauge) override;
132 double tau,
133 const double* y,
134 double* dy,
135 const perturb_parameters_and_workspace& ppaw) const override;
136
138 const double* y,
139 const double* dy,
140 PerturbSourceContext& ctx) const override;
141
143 double* y,
144 const PerturbIcContext& ctx) override;
146 double* y,
147 const PerturbIcContext& ctx) override;
149 const BaseSpecies::PerturbLayout& new_base,
150 const double* old_y,
151 double* new_y,
152 const PerturbSwitchContext& ctx) const override;
153
154 static std::vector<Named> CreateAll(const SpeciesBuildContext& ctx);
155
156 // Axion factory branch: scf_potential = axion. params = [m, f, n, Theta_ini],
157 // frozen ICs (phi = Theta*f, phi' = 0), always shoots m (tuning index 0)
158 // against Omega_scf / the closure value; m_axion is an optional Newton seed.
159 static std::vector<Named> CreateAxion(const SpeciesBuildContext& ctx,
160 const InputKeys& keys,
161 double omega0_scf);
162
163 // Shared build body for both the standalone factory (beta = 0) and the Type3
164 // composite (beta = scf_veta). Constructs the configured ScalarFieldSpecies with
165 // its shooting state set; CreateAll wraps it with the scf_veta suppression guard.
166 static std::vector<Named> CreateAllForComposite(const SpeciesBuildContext& ctx, double beta);
167
168 // ── Shooting hooks ───────────────────────────────────────────────────────
169 std::vector<ShootingTarget> GetShootingTargets() const override;
170 void ComputeShootingGuess(const SpeciesBuildContext& ctx,
171 std::vector<double>& guess,
172 std::vector<double>& dxdy) const override;
173 double ComputeShootingResidual(const ShootingResidualContext& ctx,
174 const ShootingTarget& target) const override;
175
176 StressEnergyContribution StressEnergy(const BaseSpecies::PerturbLayout& base,
177 const perturb_vector* pv,
178 const double* y,
179 const double* pvecback,
180 const perturb_workspace* ppw) const override;
181
183 PerturbColumnWriter& writer,
184 const PerturbationsModule& mod,
185 file_format fmt,
186 TransferColumnSection section = TransferColumnSection::all) const override;
187
189 const BaseSpecies::PerturbLayout* base,
190 double tau,
191 const double* y,
192 const PerturbationsModule& mod,
193 const perturb_workspace* ppw) const override;
194
195 double PPrime(double a,
196 double H,
197 const double* pvecback_B,
198 const double* pvecback) const override;
199 void FinalizeBackground(double a, double H, const double* pvecback_B, double* pvecback) override;
200
201 int bi_phi_index() const {
202 return index_bi_phi_scf_;
203 }
204 int bi_phi_prime_index() const {
205 return index_bi_phi_prime_scf_;
206 }
207
208 // Background pvecback slot accessors (used by the Type3 composite to replicate
209 // the scalar-field PrintVariables / coupling against its own nested layout).
210 int index_bg_phi_prime_scf() const {
211 return index_bg_phi_prime_scf_;
212 }
213 int index_bg_dV_scf() const {
214 return index_bg_dV_scf_;
215 }
216
217 // Suffix of this field's output columns: "scf" for the legacy field (so
218 // "phi_scf", "d_scf" are unchanged), the instance name N otherwise ("phi_N").
219 const std::string& column_tag() const {
220 return column_tag_;
221 }
222
223 private:
224 // One field from its keys, Omega already resolved: the body CreateAll runs for
225 // the legacy field and for each dot-syntax instance.
226 static std::vector<Named> CreateConfigured(const SpeciesBuildContext& ctx,
227 const InputKeys& keys,
228 double omega0_scf,
229 bool shooting_allowed);
230
231 double V_scf(double phi) const;
232 double dV_scf(double phi) const;
233 double ddV_scf(double phi) const;
234
235 ScalarFieldPotential potential_;
236
237 ShootingTarget shooting_target_{}; // unknown_param empty => no shooting target
238 bool needs_shooting_ = false; // true iff the direct unknown was absent (we guessed)
239
240 const background& pba_;
241 const BackgroundModule* bgm_ = nullptr;
242 int index_tp_delta_ = -1; // #309 transfer-source slot
243 int index_tp_theta_ = -1;
244
245 int index_bg_phi_scf_ = -1;
246 int index_bg_phi_prime_scf_ = -1;
247 int index_bg_V_scf_ = -1;
248 int index_bg_dV_scf_ = -1;
249 int index_bg_ddV_scf_ = -1;
250 int index_bg_p_prime_scf_ = -1;
251 int index_bi_phi_scf_ = -1;
252 int index_bi_phi_prime_scf_ = -1;
253 double Omega0_scf_ = 0.;
254 std::vector<double> scf_parameters_;
255 int scf_tuning_index_ = 0;
256 bool attractor_ic_scf_ = true;
257 double phi_ini_scf_ = 1.;
258 double phi_prime_ini_scf_ = 1.;
259 double beta_ = 0.;
260 std::string column_tag_;
261};
Definition base_species.h:33
Definition base_species.h:90
Definition perturb_source_context.h:63
Definition scalar_field.h:19
void PerturbSynchronousToNewtonian(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition scalar_field.cpp:359
StressEnergyContribution StressEnergy(const BaseSpecies::PerturbLayout &base, const perturb_vector *pv, const double *y, const double *pvecback, const perturb_workspace *ppw) const override
Definition scalar_field.cpp:458
void WriteOutputColumns(PerturbColumnWriter &writer, const PerturbationsModule &mod, file_format fmt, TransferColumnSection section=TransferColumnSection::all) const override
Definition scalar_field.cpp:379
void SetBackgroundInitialConditions(const BackgroundICContext &ctx) override
Definition scalar_field.cpp:73
void RegisterBackgroundIndices(int &index_bg) override
Definition scalar_field.h:80
void RegisterIntegrationIndices(int &index_bi) override
Definition scalar_field.h:91
double PPrime(double a, double H, const double *pvecback_B, const double *pvecback) const override
Definition scalar_field.cpp:143
void FinalizeBackground(double a, double H, const double *pvecback_B, double *pvecback) override
Definition scalar_field.cpp:152
double GetOmega0() const override
Definition scalar_field.h:53
void PerturbDerivs(const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
Definition scalar_field.cpp:230
double Rho(const double *pvecback) const override
Definition scalar_field.h:102
void ComputeBackground(double a, const double *pvecback_B, double *pvecback) override
Definition scalar_field.cpp:115
std::unique_ptr< BaseSpecies::PerturbLayout > CreatePerturbLayout() const override
Definition scalar_field.h:120
void FillSources(const BaseSpecies::PerturbLayout &base, const double *y, const double *dy, PerturbSourceContext &ctx) const override
Definition scalar_field.cpp:276
void PrintVariables(PerturbColumnWriter &writer, const BaseSpecies::PerturbLayout *base, double tau, const double *y, const PerturbationsModule &mod, const perturb_workspace *ppw) const override
Definition scalar_field.cpp:394
void WriteBackgroundColumnTitles(BackgroundColumnWriter &w) const override
Definition scalar_field.cpp:159
void RegisterTransferSourceIndices(int &index_tp, const SourceRequestContext &ctx) override
Definition scalar_field.cpp:209
void SetBackgroundModule(const BackgroundModule *bgm) override
Definition scalar_field.h:77
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 scalar_field.cpp:510
void ApplyInitialConditions(const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
Definition scalar_field.cpp:344
void WriteBackgroundData(const double *pvecback, BackgroundColumnWriter &w) const override
Definition scalar_field.cpp:176
double P(const double *pvecback) const override
Definition scalar_field.h:105
void PrintBackgroundDetails(const double *pvecback_today, double rho_crit_today) const override
Definition scalar_field.cpp:189
void BackgroundDerivs(double tau, const double *y, double *dy, const double *pvecback) override
Definition scalar_field.cpp:130
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 perturb_source_context.h:125
Definition perturb_source_context.h:103
Definition perturb_source_context.h:161
Definition scalar_field_potential.h:14
Definition scalar_field.h:36
Definition shooting_target.h:7
Definition shooting_target.h:14
Definition perturb_source_context.h:48
Definition species_build_context.h:58
Definition perturbations_module.h:380
Definition precision.h:79