SpaceEnvironmentRadiation

class ansys.stk.core.stkobjects.SpaceEnvironmentRadiation

Radiation model settings.

Overview

Methods

get_electron_energies	Return electron energies in an array of doubles. Uses ParticleEnergy Dimension.
get_proton_energies	Return proton energies in an array of doubles. Uses ParticleEnergy Dimension.
compute_electron_fluxes	Compute electron fluxes at the specified time, returned in an array of doubles (1 flux per electron energy). Uses FluxPerParticleEnergy Dimension.
compute_proton_fluxes	Compute proton fluxes at the specified time, returned in an array of doubles (1 flux per proton energy). Uses FluxPerParticleEnergy Dimension.
compute_dose_rates	Compute dose rate information for each shielding thickness and returns a collection to access the computed data.
compute_electron_integral_fluxes	Compute electron integral fluxes at the specified time, returned in an array of doubles (1 flux per electron energy). Uses FluxPerParticleEnergy Dimension.
compute_proton_integral_fluxes	Compute proton integral fluxes at the specified time, returned in an array of doubles (1 flux per proton energy). Uses FluxPerParticleEnergy Dimension.

Properties

computation_mode	Models that are to be included when modeling radiation.
flux_status	Info concerning the ability to compute flux values given the computation mode and Scenario’s energy values that have been set.
dose_channel	Measure of the linear energy transfer to model.
use_nuclear_attenuation	Flag to model nuclear attenuation.
detector_type	Detector material.
shielding_thicknesses	Get the shielding thicknesses. Dose and dose rate can be computed for each thickness.
ap_source	Mode for computing 15 day average Ap.
ap	Ap 15-day average value. Dimensionless.
flux_filename	Flux file containing Ap values.
include_nuclear_attenuation_neutrons	Flag to include neutrons in nuclear attenuation model.
detector_geometry	Detector geometry used by CRRES and NASA models.
use_model_epoch	Flag to use model’s epoch for magnetic field.
shift_saa	Flag to shift the SAA based on the model’s epoch.
dose_integration_step	Get or set the sampling step used for integrating dose. Uses Time Dimension.
dose_report_step	Get or set the stepsize to use for dose related data providers. Uses Time Dimension.

Import detail

from ansys.stk.core.stkobjects import SpaceEnvironmentRadiation

Property detail

property SpaceEnvironmentRadiation.computation_mode: VehicleSpaceEnvironmentComputationMode

Models that are to be included when modeling radiation.

property SpaceEnvironmentRadiation.flux_status: str

Info concerning the ability to compute flux values given the computation mode and Scenario’s energy values that have been set.

property SpaceEnvironmentRadiation.dose_channel: VehicleSpaceEnvironmentDoseChannel

Measure of the linear energy transfer to model.

property SpaceEnvironmentRadiation.use_nuclear_attenuation: bool

Flag to model nuclear attenuation.

property SpaceEnvironmentRadiation.detector_type: VehicleSpaceEnvironmentDetectorType

Detector material.

property SpaceEnvironmentRadiation.shielding_thicknesses: DoublesCollection

Get the shielding thicknesses. Dose and dose rate can be computed for each thickness.

property SpaceEnvironmentRadiation.ap_source: VehicleSpaceEnvironmentApSource

Mode for computing 15 day average Ap.

property SpaceEnvironmentRadiation.ap: float

Ap 15-day average value. Dimensionless.

property SpaceEnvironmentRadiation.flux_filename: str

Flux file containing Ap values.

property SpaceEnvironmentRadiation.include_nuclear_attenuation_neutrons: bool

Flag to include neutrons in nuclear attenuation model.

property SpaceEnvironmentRadiation.detector_geometry: VehicleSpaceEnvironmentDetectorGeometry

Detector geometry used by CRRES and NASA models.

property SpaceEnvironmentRadiation.use_model_epoch: bool

Flag to use model’s epoch for magnetic field.

property SpaceEnvironmentRadiation.shift_saa: bool

Flag to shift the SAA based on the model’s epoch.

property SpaceEnvironmentRadiation.dose_integration_step: float

Get or set the sampling step used for integrating dose. Uses Time Dimension.

property SpaceEnvironmentRadiation.dose_report_step: float

Get or set the stepsize to use for dose related data providers. Uses Time Dimension.

Method detail

SpaceEnvironmentRadiation.get_electron_energies(self) → list

Return electron energies in an array of doubles. Uses ParticleEnergy Dimension.

Returns:

list

SpaceEnvironmentRadiation.get_proton_energies(self) → list

Return proton energies in an array of doubles. Uses ParticleEnergy Dimension.

Returns:

list

SpaceEnvironmentRadiation.compute_electron_fluxes(self, time: Any) → list

Compute electron fluxes at the specified time, returned in an array of doubles (1 flux per electron energy). Uses FluxPerParticleEnergy Dimension.

Parameters:

time : Any

Returns:

list

SpaceEnvironmentRadiation.compute_proton_fluxes(self, time: Any) → list

Compute proton fluxes at the specified time, returned in an array of doubles (1 flux per proton energy). Uses FluxPerParticleEnergy Dimension.

Parameters:

time : Any

Returns:

list

SpaceEnvironmentRadiation.compute_dose_rates(self, time: Any) → SpaceEnvironmentRadiationDoseRateCollection

Compute dose rate information for each shielding thickness and returns a collection to access the computed data.

Parameters:

time : Any

Returns:

SpaceEnvironmentRadiationDoseRateCollection

SpaceEnvironmentRadiation.compute_electron_integral_fluxes(self, time: Any) → list

Compute electron integral fluxes at the specified time, returned in an array of doubles (1 flux per electron energy). Uses FluxPerParticleEnergy Dimension.

Parameters:

time : Any

Returns:

list

SpaceEnvironmentRadiation.compute_proton_integral_fluxes(self, time: Any) → list

Compute proton integral fluxes at the specified time, returned in an array of doubles (1 flux per proton energy). Uses FluxPerParticleEnergy Dimension.

Parameters:

time : Any

Returns:

list