tardis.plasma.properties package

Subpackages

• tardis.plasma.properties.continuum_processes package
  • Submodules
    • tardis.plasma.properties.continuum_processes.fast_array_util module
      • cumulative_integrate_array_by_blocks()
      • numba_cumulative_trapezoid()
    • tardis.plasma.properties.continuum_processes.photo_ion_rate_coeff module
      • PhotoIonRateCoeff
    • tardis.plasma.properties.continuum_processes.rates module
      • AdiabaticCoolingRate
      • BfHeatingRateCoeffEstimator
      • CollDeexcRateCoeff
      • CollExcRateCoeff
      • CollIonRateCoeffSeaton
      • CollRecombRateCoeff
      • CorrPhotoIonRateCoeff
      • FreeBoundCoolingRate
      • FreeBoundEmissionCDF
      • FreeFreeCoolingRate
      • LevelNumberDensityLTE
      • PhotoIonBoltzmannFactor
      • RawCollisionTransProbs
      • RawPhotoIonTransProbs
      • RawRecombTransProbs
      • RawTwoPhotonTransProbs
      • SpontRecombCoolingRateCoeff
      • StimRecombCoolingRateCoeffEstimator
      • TwoPhotonEmissionCDF
      • TwoPhotonFrequencySampler
    • tardis.plasma.properties.continuum_processes.recomb_rate_coeff module
      • SpontRecombRateCoeff
      • StimRecombRateCoeff
      • StimRecombRateFactor
  • Module contents

Submodules

• tardis.plasma.properties.atomic module
  • ContinuumInteractionHandler
    • ContinuumInteractionHandler.calculate()
    • ContinuumInteractionHandler.outputs
  • IonizationData
    • IonizationData.outputs
  • LevelIdxs2LineIdx
    • LevelIdxs2LineIdx.calculate()
    • LevelIdxs2LineIdx.outputs
  • LevelIdxs2TransitionIdx
    • LevelIdxs2TransitionIdx.calculate()
    • LevelIdxs2TransitionIdx.outputs
  • Levels
    • Levels.latex_name
    • Levels.outputs
  • Lines
    • Lines.latex_name
    • Lines.outputs
  • LinesLowerLevelIndex
    • LinesLowerLevelIndex.calculate()
    • LinesLowerLevelIndex.outputs
  • LinesUpperLevelIndex
    • LinesUpperLevelIndex.calculate()
    • LinesUpperLevelIndex.outputs
  • MacroAtomData
    • MacroAtomData.outputs
  • NLTEData
    • NLTEData.calculate()
    • NLTEData.outputs
  • PhotoIonizationData
    • PhotoIonizationData.calculate()
    • PhotoIonizationData.latex_name
    • PhotoIonizationData.outputs
  • TwoPhotonData
    • TwoPhotonData.calculate()
    • TwoPhotonData.outputs
  • YgData
    • YgData.calculate()
    • YgData.calculate_yg_van_regemorter()
    • YgData.exp1_times_exp()
    • YgData.latex_name
    • YgData.outputs
  • YgInterpolator
    • YgInterpolator.calculate()
    • YgInterpolator.latex_name
    • YgInterpolator.outputs
  • ZetaData
    • ZetaData.outputs
• tardis.plasma.properties.base module
  • ArrayInput
  • BaseAtomicDataProperty
    • BaseAtomicDataProperty.calculate()
    • BaseAtomicDataProperty.inputs
  • BasePlasmaProperty
    • BasePlasmaProperty.get_latex_label()
    • BasePlasmaProperty.name
    • BasePlasmaProperty.outputs
  • DataFrameInput
  • HiddenPlasmaProperty
  • Input
    • Input.set_value()
  • PreviousIterationProperty
    • PreviousIterationProperty.set_value()
  • ProcessingPlasmaProperty
    • ProcessingPlasmaProperty.calculate()
    • ProcessingPlasmaProperty.update()
• tardis.plasma.properties.general module
  • BetaElectron
    • BetaElectron.calculate()
    • BetaElectron.latex_formula
    • BetaElectron.latex_name
    • BetaElectron.outputs
  • BetaRadiation
    • BetaRadiation.calculate()
    • BetaRadiation.latex_formula
    • BetaRadiation.latex_name
    • BetaRadiation.outputs
  • ElectronTemperature
    • ElectronTemperature.calculate()
    • ElectronTemperature.latex_formula
    • ElectronTemperature.latex_name
    • ElectronTemperature.outputs
  • GElectron
    • GElectron.calculate()
    • GElectron.latex_formula
    • GElectron.latex_name
    • GElectron.outputs
  • SelectedAtoms
    • SelectedAtoms.calculate()
    • SelectedAtoms.outputs
  • ThermalGElectron
    • ThermalGElectron.calculate()
    • ThermalGElectron.latex_formula
    • ThermalGElectron.latex_name
    • ThermalGElectron.outputs
• tardis.plasma.properties.helium_nlte module
  • HeliumNLTE
    • HeliumNLTE.calculate()
    • HeliumNLTE.calculate_helium_one()
    • HeliumNLTE.calculate_helium_three()
    • HeliumNLTE.outputs
  • HeliumNumericalNLTE
    • HeliumNumericalNLTE.calculate()
    • HeliumNumericalNLTE.outputs
• tardis.plasma.properties.ion_population module
  • IonNumberDensity
    • IonNumberDensity.calculate()
    • IonNumberDensity.calculate_with_n_electron()
    • IonNumberDensity.latex_name
    • IonNumberDensity.outputs
  • IonNumberDensityHeNLTE
    • IonNumberDensityHeNLTE.calculate()
    • IonNumberDensityHeNLTE.latex_name
    • IonNumberDensityHeNLTE.outputs
    • IonNumberDensityHeNLTE.update_he_population()
  • PhiSahaLTE
    • PhiSahaLTE.broadcast_ionization_energy
    • PhiSahaLTE.calculate()
    • PhiSahaLTE.latex_formula
    • PhiSahaLTE.latex_name
    • PhiSahaLTE.outputs
  • PhiSahaNebular
    • PhiSahaNebular.calculate()
    • PhiSahaNebular.get_zeta_values()
    • PhiSahaNebular.latex_formula
    • PhiSahaNebular.latex_name
    • PhiSahaNebular.outputs
  • RadiationFieldCorrection
    • RadiationFieldCorrection.calculate()
    • RadiationFieldCorrection.latex_name
    • RadiationFieldCorrection.outputs
  • SahaFactor
    • SahaFactor.calculate()
    • SahaFactor.latex_name
    • SahaFactor.outputs
  • ThermalPhiSahaLTE
    • ThermalPhiSahaLTE.calculate()
    • ThermalPhiSahaLTE.latex_formula
    • ThermalPhiSahaLTE.latex_name
    • ThermalPhiSahaLTE.outputs
• tardis.plasma.properties.level_population module
  • LevelNumberDensity
    • LevelNumberDensity.calculate()
    • LevelNumberDensity.latex_formula
    • LevelNumberDensity.latex_name
    • LevelNumberDensity.outputs
  • LevelNumberDensityHeNLTE
    • LevelNumberDensityHeNLTE.calculate()
• tardis.plasma.properties.nlte module
  • PreviousBetaSobolev
    • PreviousBetaSobolev.outputs
    • PreviousBetaSobolev.set_initial_value()
  • PreviousElectronDensities
    • PreviousElectronDensities.outputs
    • PreviousElectronDensities.set_initial_value()
• tardis.plasma.properties.nlte_excitation_data module
  • NLTEExcitationData
• tardis.plasma.properties.nlte_rate_equation_solver module
  • NLTEPopulationSolverLU
    • NLTEPopulationSolverLU.calculate()
    • NLTEPopulationSolverLU.calculate_lu_solver_delta()
    • NLTEPopulationSolverLU.outputs
  • NLTEPopulationSolverRoot
    • NLTEPopulationSolverRoot.calculate()
    • NLTEPopulationSolverRoot.outputs
• tardis.plasma.properties.partition_function module
  • LevelBoltzmannFactorDiluteLTE
    • LevelBoltzmannFactorDiluteLTE.calculate()
    • LevelBoltzmannFactorDiluteLTE.latex_formula
    • LevelBoltzmannFactorDiluteLTE.latex_name
    • LevelBoltzmannFactorDiluteLTE.outputs
  • LevelBoltzmannFactorLTE
    • LevelBoltzmannFactorLTE.calculate()
    • LevelBoltzmannFactorLTE.latex_formula
    • LevelBoltzmannFactorLTE.latex_name
    • LevelBoltzmannFactorLTE.outputs
  • LevelBoltzmannFactorNLTE
    • LevelBoltzmannFactorNLTE.calculate()
    • LevelBoltzmannFactorNLTE.from_config()
    • LevelBoltzmannFactorNLTE.outputs
  • LevelBoltzmannFactorNoNLTE
    • LevelBoltzmannFactorNoNLTE.calculate()
    • LevelBoltzmannFactorNoNLTE.outputs
  • PartitionFunction
    • PartitionFunction.calculate()
    • PartitionFunction.latex_formula
    • PartitionFunction.latex_name
    • PartitionFunction.outputs
  • ThermalLTEPartitionFunction
    • ThermalLTEPartitionFunction.calculate()
    • ThermalLTEPartitionFunction.latex_name
    • ThermalLTEPartitionFunction.outputs
  • ThermalLevelBoltzmannFactorLTE
    • ThermalLevelBoltzmannFactorLTE.calculate()
    • ThermalLevelBoltzmannFactorLTE.latex_formula
    • ThermalLevelBoltzmannFactorLTE.latex_name
    • ThermalLevelBoltzmannFactorLTE.outputs
• tardis.plasma.properties.plasma_input module
  • Abundance
    • Abundance.outputs
  • AtomicData
    • AtomicData.outputs
  • ContinuumInteractionSpecies
    • ContinuumInteractionSpecies.outputs
  • DilutePlanckianRadField
    • DilutePlanckianRadField.outputs
  • DilutionFactor
    • DilutionFactor.calculate()
    • DilutionFactor.latex_name
    • DilutionFactor.outputs
  • HeliumTreatment
    • HeliumTreatment.outputs
  • IsotopeAbundance
    • IsotopeAbundance.outputs
  • JBlues
    • JBlues.latex_name
    • JBlues.outputs
  • LinkTRadTElectron
    • LinkTRadTElectron.latex_name
    • LinkTRadTElectron.outputs
  • NLTEExcitationSpecies
    • NLTEExcitationSpecies.outputs
  • NLTEIonizationSpecies
    • NLTEIonizationSpecies.outputs
  • NumberDensity
    • NumberDensity.latex_name
    • NumberDensity.outputs
  • TRadiative
    • TRadiative.calculate()
    • TRadiative.latex_name
    • TRadiative.outputs
  • TimeExplosion
    • TimeExplosion.latex_name
    • TimeExplosion.outputs
• tardis.plasma.properties.property_collections module
  • PlasmaPropertyCollection
• tardis.plasma.properties.radiative_properties module
  • BetaSobolev
    • BetaSobolev.calculate()
    • BetaSobolev.calculate_beta_sobolev()
    • BetaSobolev.latex_name
    • BetaSobolev.outputs
  • RawRadBoundBoundTransProbs
    • RawRadBoundBoundTransProbs.calculate()
    • RawRadBoundBoundTransProbs.outputs
    • RawRadBoundBoundTransProbs.transition_probabilities_outputs
  • StimulatedEmissionFactor
    • StimulatedEmissionFactor.calculate()
    • StimulatedEmissionFactor.get_g_lower()
    • StimulatedEmissionFactor.get_g_upper()
    • StimulatedEmissionFactor.get_metastable_upper()
    • StimulatedEmissionFactor.latex_formula
    • StimulatedEmissionFactor.outputs
• tardis.plasma.properties.rate_matrix_index module
  • NLTEIndexHelper
    • NLTEIndexHelper.calculate()
    • NLTEIndexHelper.calculate_rate_matrix_index()
    • NLTEIndexHelper.outputs

Module contents

Store and calculate the properties of the plasma.

Each plasma object has an array of properties which are then used to calculate plasma parameter values. Every property has a calculate function that returns the values of its outputs.