ParticleSource Class

A wrapped particle source class that allows accessing and modifying of a particle source using the API.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25.Charging.ExcitationParticleSource

Namespace: ema3d.Api.V25.Charging.Excitation
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public class ParticleSource

Public Class ParticleSource

public ref class ParticleSource

type ParticleSource = class end

The ParticleSource type exposes the following members.

Properties

	Name	Description
	AtomicNumber	Gets/sets the atomic number for the particle source. Only accessible for an ion type particle source.
	Charge	Gets/sets the charge value in electrons for an ion particle source. Set only accessible for an ion type particle source.
	ChargeDensity	Gets/sets the charge density in A/m^3 for the charge-density-shaped particle source. Set only accessible for a charge-density-shaped particle source.
	Current	Gets/sets the current in A/m^2 (in n/m^2 s for neutral particles) for the monenergetic input type particle source. Set only accessible for particle sources not of type STK or when of type File, override file currents is true.
	CylindricalPlane	Gets/sets the normal direction of the plane for a cylinder-shaped particle source. Set only accessible for a cylinder-shaped particle source.
	Direction	Gets/sets the direction for the planar-shaped particle source. Set only accessible for a planar-shaped particle source.
	Divisions	Gets/sets the number of sources for a cylinder-shaped particle source. Set only accessible for a spherical-shaped particle source.
	IncidenceType	Gets/sets the incidence type for the a spherical-shaped particle source. Set only accessible for a spherical-shaped particle source.
	IntegralFluxTime	Gets/sets the integral flux time for the manual input type particle source. Only accessible for a manual input type particle.
	NegX	Gets/sets a boolean indicating if the particle is activated in the -x direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	NegY	Gets/sets a boolean indicating if the particle is activated in the -y direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	NegZ	Gets/sets a boolean indicating if the particle is activated in the -z direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	NuclearExcitation	Gets/sets the nuclear excitation in MeV for an ion particle source. Set only accessible for an ion type particle source.
	NucleonNumber	Gets/sets the nucleon number for the particle source. Set only accessible for an ion type particle source.
	NumberParticles	Gets/sets the number of particles for the particle source.
	NumberTimeSteps	Gets/sets the number of time steps for the particle source.
	OverrideFileCurrents	Gets/sets a boolean that overrides current in imported file with the value from current. Set only accessible for a file input type particle source.
	ParticleInputType	Gets/sets the method of input for the particle source.
	ParticleType	Gets/sets the type of particle for the particle source.
	PlanarPlane	Gets/sets the normal direction of the plane for a planar-shaped particle source. Set only accessible for a planar-shaped particle source.
	PosX	Gets/sets a boolean indicating if the particle is activated in the +x direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	PosY	Gets/sets a boolean indicating if the particle is activated in the +y direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	PosZ	Gets/sets a boolean indicating if the particle is activated in the +z direction for a box-shaped source. Set only accessible for a box-shaped particle source.
	SatelliteName	Gets/sets the name of satellite to be imported from STK. Set only accessible for a STK input type particle source.
	Shape	Get/sets the shape for the particle source.
	SpectrumEnergy	Gets/sets the spectrum energy in MeV for the monenergetic input type particle source. Set only accessible for a monoenergetic input type particle source.
	SpectrumEnergyBins	Gets the spectrum energy bins for the manual input type particle source.
	SpectrumFile	Gets/sets the file name for the file input type particle source. On set, if the file exists and is different than the previous file, the spectrum file will be read in. Set only accessible for a file input type particle source.
	SyncSTK	Gets boolean indicating whether the paricle source is synced with STK. On set, if true, the spectrum file will be read from STK. Set only accessible for a STK input type particle source.

Top

Methods

	Name	Description
	Copy	Copy this ParticleSource to the same or a new document
	Create	Creates a new default ParticleSource within the document.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Charging.Excitation import ParticleSource as ParticleSource
import ema3d.Api.V25.Charging.Excitation as Excitation
# Create particle source
_ps = ParticleSource.Create(Window.ActiveWindow.Document)
# Configure Particle Source Properties
particleSource.NumberParticles = 2000
particleSource.NumberTimeSteps = 1
particleSource.ParticleType = Excitation.ParticleType.Electron
particleSource.Shape = Excitation.ParticleShape.Plane
particleSource.PlanarPlane = Excitation.ParticlePlane.Z
particleSource.Direction = Excitation.ParticleDirection.Neg

Python

Copy

from ema3d.Api.V25.Charging.Excitation import ParticleSource as ParticleSource
from System.Collections.Generic import List
import ema3d.Api.V25.Charging.Excitation as Excitation
# Create particle source
_ps = ParticleSource.Create(Window.ActiveWindow.Document)
# Configure Particle Source spectrum manually
_ps.ParticleInputType = Excitation.ParticleInputType.Manual
_ps.Current = 2e-7
_ps.IntegralFluxTime = 2
spectrumEnergyBins = List[List[float]]()
spectrumEnergyBins.Add(List[float]())
spectrumEnergyBins.Add(List[float]())
spectrumEnergyBins.Add(List[float]())
spectrumEnergyBins[0].Add(1)
spectrumEnergyBins[0].Add(1)
spectrumEnergyBins[1].Add(2)
spectrumEnergyBins[1].Add(2)
spectrumEnergyBins[2].Add(3)
spectrumEnergyBins[2].Add(3)
_ps.SpectrumEnergyBins = spectrumEnergyBins

Python

Copy

from ema3d.Api.V25.Charging.Excitation import ParticleSource as ParticleSource
import ema3d.Api.V25.Charging.Excitation as Excitation
# Create particle source
_ps = ParticleSource.Create(Window.ActiveWindow.Document)
# Configure Particle Source spectrum with a file
_ps.ParticleInputType = Excitation.ParticleInputType.File
_ps.SpectrumFile = "C:\Users\joe\Downloads\spectrum.dat"

Python

Copy

from ema3d.Api.V25.Charging.Excitation import ParticleSource as ParticleSource
import ema3d.Api.V25.Charging.Excitation as Excitation
# Create particle source
_ps = ParticleSource.Create(Window.ActiveWindow.Document)
# Configure Particle Source spectrum with STK
_ps.ParticleInputType = Excitation.ParticleInputType.STK
_ps.SatelliteName = "satellite1"
_ps.SyncSTK = True

Reference

ema3d.Api.V25.Charging.Excitation Namespace