CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
IDM_DR_IDR_Species Class Reference

#include <idm_dr_idr_species.h>

+ Inheritance diagram for IDM_DR_IDR_Species:

Public Member Functions

bool has_idm_dr () const
 
void RegisterTransferSourceIndices (int &index_tp, const SourceRequestContext &ctx) override
 
void SetPerturbs (const perturbs *ppt) override
 
void MarkUsedInSources (const BaseSpecies::PerturbLayout &base, const perturb_workspace *ppw, int *used_in_sources) const override
 
std::optional< double > GetParam (const std::string &name) const override
 
void WarnIfNonlinearUnreliable (double m_ev_threshold) const override
 
bool SupportsIsocurvatureInitialConditions () const override
 
void WriteBackgroundColumnTitles (BackgroundColumnWriter &w) const override
 
void WriteBackgroundData (const double *pvecback, BackgroundColumnWriter &w) const override
 
void ApplyInitialConditions (const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
 
void FillSources (const BaseSpecies::PerturbLayout &base, const double *y, const double *dy, PerturbSourceContext &ctx) const override
 
void WriteOutputColumns (PerturbColumnWriter &writer, const PerturbationsModule &mod, file_format fmt, TransferColumnSection section=TransferColumnSection::all) const override
 
void PrintVariables (PerturbColumnWriter &writer, const BaseSpecies::PerturbLayout *base, double tau, const double *y, const PerturbationsModule &mod, const perturb_workspace *ppw) const override
 
- Public Member Functions inherited from CompositeSpecies
std::unique_ptr< BaseSpecies::PerturbLayout > CreatePerturbLayout () const override
 
StressEnergyContribution StressEnergy (const BaseSpecies::PerturbLayout &base, const perturb_vector *pv, const double *y, const double *pvecback, const perturb_workspace *ppw) const override
 
void PerturbDerivs (const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
 
void PerturbDerivsDiagonal (const BaseSpecies::PerturbLayout &base, double tau, const double *y, double *diag, const perturb_parameters_and_workspace &ppaw) const override
 
void PerturbSynchronousToNewtonian (const BaseSpecies::PerturbLayout &base, double *y, const PerturbIcContext &ctx) override
 
void CopyPerturbationsAcrossSwitch (const BaseSpecies::PerturbLayout &old_base, const BaseSpecies::PerturbLayout &new_base, const double *old_y, double *new_y, const PerturbSwitchContext &ctx) const override
 
void RegisterBackgroundIndices (int &index_bg) override
 
void RegisterIntegrationIndices (int &index_bi) override
 
double GetOmega0 () const override
 
void AppendBudgetLines (const double *pvecback_today, double rho_crit, std::vector< BudgetLine > &out) const
 
bool SupportsExplicitPerturbationEvolver () const override
 
int MaxMultipole (const precision *ppr, bool tensors) const override
 
bool PrefersExponentialPerturbationEvolver () const override
 
bool SupportsExponentialPerturbationEvolver () const override
 
double GetRadiationOmega0 () const override
 
double DarkRadiationRhoToday (const double *pvecback_integration) const override
 
double NeutrinoOmega0 () const override
 
double NeffContribution (double z) const override
 
void PrintNeffInfo () const override
 
void PrintMassInfo () const override
 
void PrintBackgroundDetails (const double *pvecback_today, double rho_crit_today) const override
 
double TensorMasslessRelativisticRho (const double *pvecback) const override
 
double DeviationFromRadiation (const double *pvecback) const override
 
std::vector< double > FreeStreamingWavenumbers () const override
 
std::optional< double > ChildOmega0 (const std::string &name) const override
 
double BackgroundAIni (double a_proposed, double tol) const override
 
void SetBackgroundModule (const BackgroundModule *bgm) override
 
void SetThermodynamicsModule (const ThermodynamicsModule *thm) override
 
void SetBackgroundInitialConditions (const BackgroundICContext &ctx) override
 
void ComputeBackground (double a, const double *pvecback_B, double *pvecback) override
 
void BackgroundDerivs (double tau, const double *y, double *dy, const double *pvecback) override
 
void BackgroundDerivsDiagonal (double tau, const double *y, double *diag, const double *pvecback) override
 
void FinalizeBackground (double a, double H, const double *pvecback_B, double *pvecback) override
 
double Rho (const double *pvecback) const override
 
double P (const double *pvecback) const override
 
double PPrime (double a, double H, const double *pvecback_B, const double *pvecback) const override
 
double FreestreamingRho (const double *pvecback) const override
 
bool ClustersAsMatter () const override
 
bool IsColdMatterSpecies () const override
 
bool HasWarmMatter () const override
 
double NonClusteringOmega0 () const override
 
double ColdMatterRho (const double *pvecback) const override
 
double ColdMatterOmega0 () const override
 
void FinalizeMatterClassification () override
 
- Public Member Functions inherited from BaseSpecies
virtual bool IsFreestreaming () const
 
bool IsPresent () const
 
int bg_rho_index () const
 
virtual void ProcessBackgroundTable (const double *, int, int, const double *)
 
virtual void PerturbVectorDerivs (const PerturbLayout &, double, const double *, double *, const perturb_parameters_and_workspace &) const
 
virtual void PerturbTensorDerivs (const PerturbLayout &, double, const double *, double *, const perturb_parameters_and_workspace &) const
 
virtual void ApplyTensorInitialConditions (const PerturbLayout &, double *, double, const double *) const
 
virtual void WriteTensorOutputColumnTitles (std::string &) const
 
virtual void ContributeTensorGwSource (const PerturbLayout &, double, const double *, perturb_workspace *) const
 
virtual int ApproximationCount () const
 
virtual int ApproximationRegimeAt (int, double, const double *) const
 
int ApproximationRegime (const perturb_workspace *ppw, int which=0) const
 
int ApproximationRegimeBefore (const PerturbSwitchContext &ctx, int which=0) const
 
virtual bool SupportsNewtonianGauge () const
 
virtual double RhoPrimeOverRho (const double *pvecback, double a_prime_over_a) const
 
virtual double BackgroundDensityOverH0Sq (double a, double H0) const
 
bool ClustersAsMatterCached () const
 
virtual bool HasNcdm () const
 
virtual double SourceSamplingRate (const double *) const
 

Protected Member Functions

void AddCouplingDerivs (double tau, const double *y, double *dy, const perturb_parameters_and_workspace &ppaw) const override
 
- Protected Member Functions inherited from BaseSpecies
void ApplyFluidLikeNewtonianShift (double *y, int idx_delta, int idx_theta, const double *pvecback, const PerturbIcContext &ctx) const
 

Additional Inherited Members

- Public Types inherited from BaseSpecies
enum class  EnergyType
 

Detailed Description

IDM_DR_IDR_Species: composite for interacting dark matter + interacting dark radiation.

Children handle free-streaming terms; this composite's AddCouplingDerivs adds the momentum-exchange and TCA terms that couple IDM_DR to IDR.

Member Function Documentation

◆ has_idm_dr()

bool IDM_DR_IDR_Species::has_idm_dr ( ) const
inline

Per-sub-species presence, captured at construction (== pba->has_* at build time). The composite is created on has_idm_dr || has_idr, so callers needing the individual flags must use these rather than count("IDM_DR_IDR").

◆ RegisterTransferSourceIndices()

void IDM_DR_IDR_Species::RegisterTransferSourceIndices ( int &  ,
const SourceRequestContext &   
)
overridevirtual

Register this species' transfer-source (index_tp) slots. Set once in perturb_indices_of_perturbs() before the k-loop; mirrors RegisterBackgroundIndices (k-independent, cached in a plain species member). Takes no PerturbLayout — that absence marks it as non-per-k state. Default: no-op (species that emit no transfer functions).

Reimplemented from CompositeSpecies.

◆ SetPerturbs()

void IDM_DR_IDR_Species::SetPerturbs ( const perturbs *  )
inlineoverridevirtual

Called by PerturbationsModule during construction to provide access to the perturbs struct (alpha_idm_dr, gauge, etc.). Default: no-op.

Reimplemented from CompositeSpecies.

◆ MarkUsedInSources()

void IDM_DR_IDR_Species::MarkUsedInSources ( const BaseSpecies::PerturbLayout &  base,
const perturb_workspace *  ppw,
int *  used_in_sources 
) const
overridevirtual

IDR l>=3 multipoles not needed in sources when rsa_idr is off, idr is free-streaming, and tca_idm_dr is off.

Reimplemented from BaseSpecies.

◆ GetParam()

std::optional< double > IDM_DR_IDR_Species::GetParam ( const std::string &  ) const
overridevirtual

Generic species-param accessor for the Python wrapper layer and cross-module readers that don't want to downcast. Each species may opt in by overriding this and returning the named param; default is std::nullopt.

Reimplemented from BaseSpecies.

◆ WarnIfNonlinearUnreliable()

void IDM_DR_IDR_Species::WarnIfNonlinearUnreliable ( double  m_ev_threshold) const
overridevirtual

Halofit and HMcode are calibrated on CDM; interacting dark matter makes them unreliable.

Reimplemented from CompositeSpecies.

◆ SupportsIsocurvatureInitialConditions()

bool IDM_DR_IDR_Species::SupportsIsocurvatureInitialConditions ( ) const
inlineoverridevirtual

The dark tight coupling and the idr hierarchy are seeded for adiabatic modes only.

Reimplemented from BaseSpecies.

◆ WriteBackgroundColumnTitles()

void IDM_DR_IDR_Species::WriteBackgroundColumnTitles ( BackgroundColumnWriter &  ) const
overridevirtual

Write this species' background column titles into writer. Called by BackgroundModule::background_output_titles(). Default: no-op (species with no background output need not override).

Reimplemented from BaseSpecies.

◆ WriteBackgroundData()

void IDM_DR_IDR_Species::WriteBackgroundData ( const double *  ,
BackgroundColumnWriter &   
) const
overridevirtual

Write this species' background data values into writer. pvecback is the full background vector at the current time step. Called by BackgroundModule::background_output_data(). Default: no-op.

Reimplemented from BaseSpecies.

◆ ApplyInitialConditions()

void IDM_DR_IDR_Species::ApplyInitialConditions ( const BaseSpecies::PerturbLayout &  ,
double *  ,
const PerturbIcContext &   
)
overridevirtual

Write synchronous-gauge initial conditions for this species into y[]. y[] == ppw->pv->y. The module pre-computes ctx.delta_g_ic, ctx.delta_ur, etc. Guard each IC type: if (ctx.index_ic == ctx.p_mod->index_ic_ad_) { ... } Newtonian gauge transformation is handled by the module after this loop. Default: no-op.

Reimplemented from CompositeSpecies.

◆ FillSources()

void IDM_DR_IDR_Species::FillSources ( const BaseSpecies::PerturbLayout &  ,
const double *  ,
const double *  ,
PerturbSourceContext &   
) const
overridevirtual

Write per-k, per-tau source values for this species into the source table. Called in perturb_sources() after metric/temperature sources are set. Use ctx.p_mod->SetSourceValue(ctx.index_md, ctx.index_ic, ctx.p_mod->index_tp_XXX_, ctx.index_tau, ctx.index_k, value). All addressing (index_md, index_ic, index_k, index_tau) is in ctx. Default: no-op.

Reimplemented from CompositeSpecies.

◆ WriteOutputColumns()

void IDM_DR_IDR_Species::WriteOutputColumns ( PerturbColumnWriter &  writer,
const PerturbationsModule &  mod,
file_format  fmt,
BaseSpecies::TransferColumnSection  section = TransferColumnSection::all 
) const
overridevirtual

Names every child's transfer columns, in children_ order. Chained like every other per-species hook so that a composite which allocates a child's source slot (RegisterTransferSourceIndices) and fills it (FillSources) also names it — without this the columns are computed every step and thrown away, and d_tot is not reconstructible from the d_i (issue #391). Composites that own slots at composite level override and chain to this first.

Reimplemented from CompositeSpecies.

◆ PrintVariables()

void IDM_DR_IDR_Species::PrintVariables ( PerturbColumnWriter &  writer,
const BaseSpecies::PerturbLayout *  base,
double  tau,
const double *  y,
const PerturbationsModule &  mod,
const perturb_workspace *  ppw 
) const
overridevirtual

Chains each child's k_output_values columns, in children_ order. Composites that publish sector-level aggregates their children cannot form (the DNCDM a4Pi decomposition) override and add those on top.

Reimplemented from CompositeSpecies.

◆ AddCouplingDerivs()

void IDM_DR_IDR_Species::AddCouplingDerivs ( double  tau,
const double *  y,
double *  dy,
const perturb_parameters_and_workspace &  ppaw 
) const
overrideprotectedvirtual

Override in concrete subclasses to add coupling terms to dy after all children have written their free-streaming contributions. Default: no-op.

Reimplemented from CompositeSpecies.


The documentation for this class was generated from the following files: