#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 &layout, const perturb_workspace ppw, int used_in_sources) const override

std::optional< double >	GetParam (const std::string &name) const override

void	WriteBackgroundColumnTitles (BackgroundColumnWriter &w) const override

void	WriteBackgroundData (const double *pvecback, BackgroundColumnWriter &w) const override

void	ApplyInitialConditions (const BaseSpecies::PerturbLayout &layout, double *y, const PerturbIcContext &ctx) override

void	FillSources (const BaseSpecies::PerturbLayout &layout, 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, 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 &layout, const perturb_vector pv, const double y, const double pvecback, const perturb_workspace ppw) const override

void	PerturbDerivs (const BaseSpecies::PerturbLayout &layout, double tau, const double y, double dy, const perturb_parameters_and_workspace &ppaw) const override

void	PerturbSynchronousToNewtonian (const BaseSpecies::PerturbLayout &layout, double *y, const PerturbIcContext &ctx) override

void	CopyPerturbationsAcrossSwitch (const BaseSpecies::PerturbLayout &old_layout, const BaseSpecies::PerturbLayout &new_layout, 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

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

double	TensorMasslessRelativisticRho (const double *pvecback) const override

void	CheckUltraRelativisticAtIc (const double *pvecback, double tol) const override

bool	IsUltraRelativisticAtIc (const double *pvecback, double tol) const override

void	WarnIfTooHeavyForHalofit (double m_ev_threshold) 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	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

void	FinalizeMatterClassification () override

Public Member Functions inherited from BaseSpecies
virtual bool	IsFreestreaming () const

bool	IsPresent () 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	WriteTensorOutputColumnTitles (std::string &) const

virtual void	ContributeTensorGwSource (const PerturbLayout &, double, const double , perturb_workspace ) const

virtual double	RhoDotOverRho (const double *pvecback, double a_prime_over_a) const

bool	ClustersAsMatterCached () 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 &	layout,
		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.

◆ 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_member() 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 &	,
		const PerturbationsModule &	,
		file_format	,
		BaseSpecies::TransferColumnSection	= `TransferColumnSection::all`
	)		const

overridevirtual

Append this species' output columns (delta, theta) to writer. Called from perturb_output_titles (title mode) and perturb_output_data (data mode). In class_format, the module may call this separately for density and velocity sections to preserve the historical transfer-column ordering. Use writer.Add(title, mod.index_tp_XXX_, active) — writer looks up tk[tp_index].

Reimplemented from BaseSpecies.

◆ PrintVariables()

void IDM_DR_IDR_Species::PrintVariables	(	PerturbColumnWriter &	,
		double	,
		const double *	,
		const PerturbationsModule &	,
		const perturb_workspace *
	)		const

overridevirtual

Append this species' time-evolution variables to writer. Called from perturb_prepare_k_output (title mode, tau=0/y=nullptr/ppw=nullptr) and perturb_print_variables_member (data mode). Guard computation behind: if (!writer.IsTitleMode()) { ... compute ... } Use writer.Add(title, computed_value, active).

Reimplemented from BaseSpecies.

◆ 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:

idm_dr_idr_species.h
idm_dr_idr_species.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ has_idm_dr()

◆ RegisterTransferSourceIndices()

◆ SetPerturbs()

◆ MarkUsedInSources()

◆ GetParam()

◆ WriteBackgroundColumnTitles()

◆ WriteBackgroundData()

◆ ApplyInitialConditions()

◆ FillSources()

◆ WriteOutputColumns()

◆ PrintVariables()

◆ AddCouplingDerivs()