Go to www.awrcorp.com
Back to search page Click to download printable version of this guide.

A.175. IMICHELLE_ParticleFileControls

Function Name Arguments Return Value

GetAxialEnergyOffsetEV

None

double

GetAxialEnergyOffsetEVDirectionVector

None

tuple[double]

GetAxialOverrideBeamRotationAngle

None

double

GetAxialOverrideDirection

None

string

GetAxialOverrideDirection

bool Evaluated

string

GetAxialOverrideEnable

None

bool

GetAxialOverrideRandomizeAngle

None

bool

GetAxialOverrideValue

None

double

GetColumnOrder

None

string

GetCurrentMultiplier

None

double

GetCurrentUnits

None

string

GetCurrentUnits

bool Evaluated

string

GetEnableDataInfo

None

bool

GetEnableTDPreserveInitialTimestep

None

bool

GetEnableTDRandomInitialTimestep

None

bool

GetEnergyOverrideAxialOnly

None

bool

GetEnergyOverrideValueEV

None

double

GetExAxialEnergyOffsetEV

None

string

GetExAxialEnergyOffsetEVDirectionVector

None

string

GetExAxialOverrideBeamRotationAngle

None

string

GetExAxialOverrideDirection

None

string

GetExAxialOverrideEnable

None

string

GetExAxialOverrideRandomizeAngle

None

string

GetExAxialOverrideValue

None

string

GetExColumnOrder

None

string

GetExCurrentMultiplier

None

string

GetExCurrentUnits

None

string

GetExEnableDataInfo

None

string

GetExEnableTDPreserveInitialTimestep

None

string

GetExEnableTDRandomInitialTimestep

None

string

GetExEnergyOverrideAxialOnly

None

string

GetExEnergyOverrideValueEV

None

string

GetExGeometryType

None

string

GetExIBeamDirection

None

string

GetExLengthUnits

None

string

GetExMomentumOrEnergyUnits

None

string

GetExNumberParticles

None

None

GetExOffsetX

None

string

GetExOffsetY

None

string

GetExOffsetZ

None

string

GetExOscillationFrequency

None

string

GetExOscillationPeriod

None

string

GetExPeriodAveragedData

None

string

GetExSpaceChargeDepressionOverride

None

string

GetExSpaceChargeDepressionOverrideAxialOnly

None

string

GetExSpaceChargeDepressionOverrideRefPotential

None

string

GetExSteadyBeam

None

string

GetExTimeDomainBeam

None

string

GetExTimeOffset

None

string

GetExTimeStepSeconds

None

string

GetExTotalCurrent

None

None

GetExUseAbsoluteTime

None

string

GetExVolumetricBeam

None

string

GetGeometryType

None

string

GetGeometryType

bool Evaluated

string

GetIBeamDirection

None

string

GetIBeamDirection

bool Evaluated

string

GetLengthUnits

None

string

GetLengthUnits

bool Evaluated

string

GetMomentumOrEnergyUnits

None

string

GetMomentumOrEnergyUnits

bool Evaluated

string

GetNumberParticles

None

None

GetOffsetX

None

double

GetOffsetY

None

double

GetOffsetZ

None

double

GetOscillationFrequency

None

double

GetOscillationPeriod

None

double

GetPeriodAveragedData

None

bool

GetSelectedAxialEnergyOffsetEV

None

double

GetSelectedAxialEnergyOffsetEVDirectionVector

None

tuple[double]

GetSelectedAxialOverrideBeamRotationAngle

None

double

GetSelectedAxialOverrideEnable

None

bool

GetSelectedAxialOverrideRandomizeAngle

None

bool

GetSelectedAxialOverrideValue

None

double

GetSelectedColumnOrder

None

string

GetSelectedCurrentMultiplier

None

double

GetSelectedEnableDataInfo

None

bool

GetSelectedEnableTDPreserveInitialTimestep

None

bool

GetSelectedEnableTDRandomInitialTimestep

None

bool

GetSelectedEnergyOverrideAxialOnly

None

bool

GetSelectedEnergyOverrideValueEV

None

double

GetSelectedNumberParticles

None

None

GetSelectedOffsetX

None

double

GetSelectedOffsetY

None

double

GetSelectedOffsetZ

None

double

GetSelectedOscillationFrequency

None

double

GetSelectedOscillationPeriod

None

double

GetSelectedPeriodAveragedData

None

bool

GetSelectedSpaceChargeDepressionOverride

None

bool

GetSelectedSpaceChargeDepressionOverrideAxialOnly

None

bool

GetSelectedSpaceChargeDepressionOverrideRefPotential

None

double

GetSelectedSteadyBeam

None

bool

GetSelectedTimeDomainBeam

None

bool

GetSelectedTimeOffset

None

double

GetSelectedTimeStepSeconds

None

double

GetSelectedTotalCurrent

None

None

GetSelectedUseAbsoluteTime

None

bool

GetSelectedVolumetricBeam

None

bool

GetSpaceChargeDepressionOverride

None

bool

GetSpaceChargeDepressionOverrideAxialOnly

None

bool

GetSpaceChargeDepressionOverrideRefPotential

None

double

GetSteadyBeam

None

bool

GetTimeDomainBeam

None

bool

GetTimeOffset

None

double

GetTimeStepSeconds

None

double

GetTotalCurrent

None

None

GetUseAbsoluteTime

None

bool

GetVolumetricBeam

None

bool

ListAxialOverrideDirection

None

tuple[string]

ListCurrentUnits

None

tuple[string]

ListGeometryType

None

tuple[string]

ListIBeamDirection

None

tuple[string]

ListLengthUnits

None

tuple[string]

ListMomentumOrEnergyUnits

None

tuple[string]

SetAxialEnergyOffsetEV

double value

None

SetAxialEnergyOffsetEVDirectionVector

tuple[double] value

None

SetAxialOverrideBeamRotationAngle

double value

None

SetAxialOverrideDirection

string value

None

SetAxialOverrideEnable

bool value

None

SetAxialOverrideRandomizeAngle

bool value

None

SetAxialOverrideValue

double value

None

SetColumnOrder

string value

None

SetCurrentMultiplier

double value

None

SetCurrentUnits

string value

None

SetEnableDataInfo

bool value

None

SetEnableTDPreserveInitialTimestep

bool value

None

SetEnableTDRandomInitialTimestep

bool value

None

SetEnergyOverrideAxialOnly

bool value

None

SetEnergyOverrideValueEV

double value

None

SetExAxialEnergyOffsetEV

string value

None

SetExAxialEnergyOffsetEVDirectionVector

string value

None

SetExAxialOverrideBeamRotationAngle

string value

None

SetExAxialOverrideDirection

string value

None

SetExAxialOverrideEnable

string value

None

SetExAxialOverrideRandomizeAngle

string value

None

SetExAxialOverrideValue

string value

None

SetExColumnOrder

string value

None

SetExCurrentMultiplier

string value

None

SetExCurrentUnits

string value

None

SetExEnableDataInfo

string value

None

SetExEnableTDPreserveInitialTimestep

string value

None

SetExEnableTDRandomInitialTimestep

string value

None

SetExEnergyOverrideAxialOnly

string value

None

SetExEnergyOverrideValueEV

string value

None

SetExGeometryType

string value

None

SetExIBeamDirection

string value

None

SetExLengthUnits

string value

None

SetExMomentumOrEnergyUnits

string value

None

SetExNumberParticles

string value

None

SetExOffsetX

string value

None

SetExOffsetY

string value

None

SetExOffsetZ

string value

None

SetExOscillationFrequency

string value

None

SetExOscillationPeriod

string value

None

SetExPeriodAveragedData

string value

None

SetExSpaceChargeDepressionOverride

string value

None

SetExSpaceChargeDepressionOverrideAxialOnly

string value

None

SetExSpaceChargeDepressionOverrideRefPotential

string value

None

SetExSteadyBeam

string value

None

SetExTimeDomainBeam

string value

None

SetExTimeOffset

string value

None

SetExTimeStepSeconds

string value

None

SetExTotalCurrent

string value

None

SetExUseAbsoluteTime

string value

None

SetExVolumetricBeam

string value

None

SetGeometryType

string value

None

SetIBeamDirection

string value

None

SetLengthUnits

string value

None

SetMomentumOrEnergyUnits

string value

None

SetNumberParticles

int value

None

SetOffsetX

double value

None

SetOffsetY

double value

None

SetOffsetZ

double value

None

SetOscillationFrequency

double value

None

SetOscillationPeriod

double value

None

SetPeriodAveragedData

bool value

None

SetSpaceChargeDepressionOverride

bool value

None

SetSpaceChargeDepressionOverrideAxialOnly

bool value

None

SetSpaceChargeDepressionOverrideRefPotential

double value

None

SetSteadyBeam

bool value

None

SetTimeDomainBeam

bool value

None

SetTimeOffset

double value

None

SetTimeStepSeconds

double value

None

SetTotalCurrent

double value

None

SetUseAbsoluteTime

bool value

None

SetVolumetricBeam

bool value

None

Please send email to awr.support@ni.com if you would like to provide feedback on this article. Please make sure to include the article link in the email.

Legal and Trademark Notice