tardis.iip_plasma.properties.partition_function module

class tardis.iip_plasma.properties.partition_function.LTEPartitionFunction(plasma_parent)

Bases: PartitionFunction

calculate(lte_level_boltzmann_factor)

outputs = ('lte_partition_function',)

class tardis.iip_plasma.properties.partition_function.LTEPartitionFunctionTe(plasma_parent)

Bases: PartitionFunction

calculate(lte_level_boltzmann_factor_Te)

outputs = ('lte_partition_function_Te',)

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorDiluteLTE(plasma_parent)

Bases: ProcessingPlasmaProperty

Attributes:

general_level_boltzmann_factorPandas DataFrame, dtype float

Level population proportionality values. Indexed by atomic number, ion number, level number. Columns corresponding to zones. Dilute radiation field means non-metastable level values are multiplied by an additional factor W. Does not consider NLTE.

calculate(levels, g, excitation_energy, beta_rad, w, metastability)

latex_formula = ('Wg_{i,j,k}e^{\\dfrac{-\\epsilon_{i,j,k}}{k_{        \\textrm{B}}T_{\\textrm{rad}}}}',)

latex_name = ('bf_{i,j,k}',)

outputs = ('general_level_boltzmann_factor',)

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorLTE(plasma_parent)

Bases: ProcessingPlasmaProperty

Attributes:

general_level_boltzmann_factorPandas DataFrame, dtype float

Level population proportionality values. Indexed by atomic number, ion number, level number. Columns corresponding to zones. Does not consider NLTE.

static calculate(excitation_energy, g, beta_rad, levels)

latex_formula = ('g_{i,j,k}e^{\\dfrac{-\\epsilon_{i,j,k}}{k_{        \\textrm{B}}T_{\\textrm{rad}}}}',)

latex_name = ('bf_{i,j,k}',)

outputs = ('general_level_boltzmann_factor',)

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorLTECont(plasma_parent)

Bases: LevelBoltzmannFactorLTE

outputs = ('lte_level_boltzmann_factor',)

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorLTETe(plasma_parent)

Bases: LevelBoltzmannFactorLTE

Attributes:

level_boltzmann_factor_LTE_TePandas DataFrame, dtype float

Level population proportionality values for LTE. Evaluated at the kinetic temperature T_e. Indexed by atomic number, ion number, level number. Columns corresponding to zones.

static calculate(excitation_energy, g, beta_electron, levels)

latex_formula = ('g_{i,j,k}e^{\\dfrac{-\\epsilon_{i,j,k}}{k_{        \\textrm{B}}T_{\\textrm{electron}}}}',)

latex_name = ('bf_{i,j,k}^{\\textrm{LTE}}(T_e)',)

outputs = ('lte_level_boltzmann_factor_Te',)

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorNLTE(plasma_parent, classical_nebular=False, coronal_approximation=False)

Bases: ProcessingPlasmaProperty

Attributes:

level_boltzmann_factorPandas DataFrame, dtype float

Returns general_level_boltzmann_factor but updated for those species treated in NLTE.

Selects appropriate ‘calculate’ function based on NLTE config options selected.

calculate()

outputs = ('level_boltzmann_factor', 'ion_ratio')

class tardis.iip_plasma.properties.partition_function.LevelBoltzmannFactorNoNLTE(plasma_parent)

Bases: ProcessingPlasmaProperty

Attributes:

level_boltzmann_factorPandas DataFrame, dtype float

Returns general_level_boltzmann_factor as this property is included if NLTE is not used.

static calculate(general_level_boltzmann_factor)

outputs = ('level_boltzmann_factor',)

class tardis.iip_plasma.properties.partition_function.PartitionFunction(plasma_parent)

Bases: ProcessingPlasmaProperty

Attributes:

partition_functionPandas DataFrame, dtype float

Indexed by atomic number, ion number. Columns are zones.

static calculate(level_boltzmann_factor)

latex_formula = ('\\sum_{k}bf_{i,j,k}',)

latex_name = ('Z_{i,j}',)

outputs = ('partition_function',)