species_build_context.h

#pragma once
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "base_species.h"
 
class FileContent;
struct background;
struct precision;
class BackgroundModule;
struct NcdmSettings;
class SpeciesCollection;
 
struct SpeciesOmegaBudget {
  std::optional<double> cdm;
  std::optional<double> dcdmdr;
  std::optional<double> idm_dr;
  std::optional<double> idr;
  std::optional<double> idm_drmd;
  std::optional<double> idr_drmd;
};
 
struct CoupledClusterInputs {
  std::optional<double> T_idr;  // resolved from N_idr | N_dg | xi_idr (+ stat_f_idr)
  double stat_f_idr         = 7. / 8.;
  double f_idm_drmd         = 0.;
  double G_over_aH_drmd_ini = 0.;
  double delta_Neff_drmd    = 0.;
  double z_stop             = 0.;
};
 
struct SpeciesBuildContext {
  FileContent* pfc;
  const background* pba;
  const precision* ppr;
  const NcdmSettings* ncdm_settings;  // non-null
  const BackgroundModule* bgm;        // nullptr at species-construction time
  const SpeciesCollection* all_species = nullptr;
  // ^ ConstructSpecies passes a non-null pointer for the whole build, but the
  // collection is filled incrementally — earlier factories in Pass 1 see fewer
  // entries than later ones. nullptr in pre-construction / standalone contexts
  // (e.g. DoShooting's per-species shooting-guess loop).
 
  // Pre-resolved Omega budget for the coupled-species cluster.  Populated by
  // InputModule before ConstructSpecies runs and threaded through to DoShooting's
  // per-species guess loop; default nullptr for standalone callers (tests etc.).
  const SpeciesOmegaBudget* omega_budget = nullptr;
 
  // Raw intermediates parsed once in phase i that the coupled factories need for
  // physics construction (not just budget math). nullptr for standalone callers.
  const CoupledClusterInputs* coupled_inputs = nullptr;
 
  // Set by ConstructSpecies when running Pass 2 (closure species). Carries the
  // budget-closure value Omega0 that the closure species must adopt instead of
  // reading its Omega from the input file. std::nullopt for Pass 1 and for
  // non-closure species.
  std::optional<double> omega0_closure_override;
};
 
struct Named {
  std::string key;
  std::unique_ptr<BaseSpecies> species;
};