torax.sources.impurity_radiation_heat_sink package

Submodules

torax.sources.impurity_radiation_heat_sink.impurity_radiation_constant_fraction module

Impurity radiation heat sink for electron heat equation based on constant fraction of total power density.

class torax.sources.impurity_radiation_heat_sink.impurity_radiation_constant_fraction.DynamicRuntimeParams(prescribed_values, fraction_of_total_power_density)[source]

Bases: DynamicRuntimeParams, Mapping

Parameters:

  • prescribed_values (tuple[Union[Float[Array, 'rhon'], Float[ndarray, 'rhon']], ...])

  • fraction_of_total_power_density (Union[Float[Array, ''], Float[ndarray, ''], number, float])

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
values() → an object providing a view on D's values
class torax.sources.impurity_radiation_heat_sink.impurity_radiation_constant_fraction.ImpurityRadiationHeatSinkConstantFractionConfig(**data)[source]

Bases: SourceModelBase

Configuration for the ImpurityRadiationHeatSink.

fraction_of_total_power_density

Fraction of total power density to be absorbed by the impurity.

Parameters:

data (Any)

build_dynamic_params(t)[source]

Builds dynamic runtime parameters for the source.

Parameters:

t (Union[Array, ndarray, bool, number, float, int])

Return type:

DynamicRuntimeParams

build_source()[source]

Builds a source object from the model config.

Return type:

ImpurityRadiationHeatSink

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property model_func: SourceProfileFunction

Returns the model function for the source.

torax.sources.impurity_radiation_heat_sink.impurity_radiation_constant_fraction.radially_constant_fraction_of_Pin(unused_static_runtime_params_slice, dynamic_runtime_params_slice, geo, source_name, unused_core_profiles, calculated_source_profiles)[source]

Model function for radiation heat sink from impurities.

This model represents a sink in the temp_el equation, whose value is a fixed % of the total heating power input.

Parameters:

  • unused_static_runtime_params_slice (StaticRuntimeParamsSlice) – Static runtime parameters.

  • dynamic_runtime_params_slice (DynamicRuntimeParamsSlice) – Dynamic runtime parameters.

  • geo (Geometry) – Geometry object.

  • source_name (str) – Name of the source.

  • unused_core_profiles (CoreProfiles) – Core profiles object.

  • calculated_source_profiles (SourceProfiles | None) – Source profiles which have already been calculated and can be used to avoid recomputing them.

Return type:

tuple[Union[Array, ndarray, bool, number], ...]

Returns:

The heat sink profile.

torax.sources.impurity_radiation_heat_sink.impurity_radiation_heat_sink module

Class for impurity radiation heat sinks.

Model functions are in separate files.

class torax.sources.impurity_radiation_heat_sink.impurity_radiation_heat_sink.ImpurityRadiationHeatSink(*, model_func=None)[source]

Bases: Source

Impurity radiation heat sink for electron heat equation.

Parameters:

model_func (Optional[SourceProfileFunction])

property affected_core_profiles: tuple[AffectedCoreProfile, ...]

Returns the core profiles affected by this source.

property source_name: str

Returns the name of the source.

torax.sources.impurity_radiation_heat_sink.impurity_radiation_mavrin_fit module

Routines for calculating impurity radiation based on a polynomial fit.

class torax.sources.impurity_radiation_heat_sink.impurity_radiation_mavrin_fit.DynamicRuntimeParams(prescribed_values, radiation_multiplier)[source]

Bases: DynamicRuntimeParams, Mapping

Parameters:

  • prescribed_values (tuple[Union[Float[Array, 'rhon'], Float[ndarray, 'rhon']], ...])

  • radiation_multiplier (Union[Float[Array, ''], Float[ndarray, ''], number, float])

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
values() → an object providing a view on D's values
class torax.sources.impurity_radiation_heat_sink.impurity_radiation_mavrin_fit.ImpurityRadiationHeatSinkMavrinFitConfig(**data)[source]

Bases: SourceModelBase

Configuration for the ImpurityRadiationHeatSink.

radiation_multiplier

Multiplier for the impurity radiation profile.

Parameters:

data (Any)

build_dynamic_params(t)[source]

Builds dynamic runtime parameters for the source.

Parameters:

t (Union[Array, ndarray, bool, number, float, int])

Return type:

DynamicRuntimeParams

build_source()[source]

Builds a source object from the model config.

Return type:

ImpurityRadiationHeatSink

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property model_func: SourceProfileFunction

Returns the model function for the source.

torax.sources.impurity_radiation_heat_sink.impurity_radiation_mavrin_fit.calculate_total_impurity_radiation(ion_symbols, ion_mixture, Te)[source]

Calculates impurity line radiation profile (JAX-compatible).

Parameters:

  • ion_symbols (Sequence[str]) – Ion symbols of the impurity species.

  • ion_mixture (DynamicIonMixture) – DynamicIonMixture object containing impurity information.

  • Te (Union[Float[Array, 'rhon'], Float[ndarray, 'rhon']]) – Electron temperature [keV]. Can be any sized array, e.g. on cell grid, face grid, or a single scalar.

Returns:

Total effective radiative cooling rate in units of Wm^3,

summed over all species in the mixture. The shape of LZ is the same as Te.

Return type:

effective_LZ

torax.sources.impurity_radiation_heat_sink.impurity_radiation_mavrin_fit.impurity_radiation_mavrin_fit(static_runtime_params_slice, dynamic_runtime_params_slice, unused_geo, source_name, core_profiles, unused_calculated_source_profiles)[source]

Model function for impurity radiation heat sink.

Parameters:
Return type:

tuple[Union[Array, ndarray, bool, number], ...]

Module contents

This package contains the Source class and model functions for impurity radiation.