TimeSteps Class

A wrapped FEM computational time object attached to a Charge Domain.

Inheritance Hierarchy

SystemObject
ema3d.Api.V26.Charging.DomainChargeDomainChildBaseTimeSteps
ema3d.Api.V26.Charging.DomainTimeSteps

Namespace: ema3d.Api.V26.Charging.Domain
Assembly: ema3d.Api.V26 (in ema3d.Api.V26.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class TimeSteps : ChargeDomainChildBase<TimeSteps>

Public NotInheritable Class TimeSteps
	Inherits ChargeDomainChildBase(Of TimeSteps)

public ref class TimeSteps sealed : public ChargeDomainChildBase<TimeSteps^>

[<SealedAttribute>]
type TimeSteps = 
    class
        inherit ChargeDomainChildBase<TimeSteps>
    end

The TimeSteps type exposes the following members.

Properties

	Name	Description
	EndTime	The simulation end time in surface charging simulations.
	InternalOutputFrequency	Output frequency of internal charging simulations.
	InternalOutputFrequencyList	A list of the output frequencies for internal charging simulations.
	InternalStepNumber	Total number of timesteps in internal charging simulations.
	InternalStepNumberList	A list of the total number of timesteps in internal charging simulations.
	InternalStepTime	Timestep size (s) for internal charging simulations.
	InternalStepTimeList	A list of timestep sizes (s) for internal charging simulations.
	IrradiationTime	Irradiation time (s) for radiation hardening simulations.
	MaxStep	Maximum timestep used in Charge simulation.
	MinStep	Minimum timestep used in Charge simulation.
	NumSteps	Number of timesteps used in surface charging simulations.
	OutputFrequency	Output frequency used in surface charging simulations.
	PICTimeSync	A boolean flag to enable / disable synchronization with steps in the PIC simulation.

Top

Methods

	Name	Description
	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

Remarks

This object is always attached to a parent Charge Domain and cannot be created individually. Modifications to, and copies of, this object will operate on the single Charge Domain within the document.

Example

Python

Copy

from ema3d.Api.V26.Charging.Domain import ChargeDomain as ChargeDomain
from ema3d.Api.V26.Charging.Domain import ChargingEnvironment as ChargingEnvironment

_cd = ChargeDomain.GetInstance(Window.ActiveWindow.Document)
_cd.SwitchChargingOptions.SimulationType = ChargingEnvironment.Custom

# sets surface charging simulation options
_cd.TimeStepSettings.MinStep = 1e-8
_cd.TimeStepSettings.MaxStep = 25
_cd.TimeStepSettings.EndTime = 1100
_cd.TimeStepSettings.NumSteps = 300
_cd.TimeStepSettings.OutputFrequency = 2

# sets internal charging simulation options
_cd.TimeStepSettings.InternalStepTime = 5e-9
_cd.TimeStepSettings.InternalStepNumber = 80
_cd.TimeStepSettings.InternalOutputFrequency = 8

# internal charging simulation options can also be set as lists
# _cd.TimeStepSettings.InternalStepTimeList = List[float]([1e-9, 2e-9])
# _cd.TimeStepSettings.InternalStepNumberList = List[int]([200,250])
# _cd.TimeStepSettings.InternalOutputFrequencyList = List[float]([2.0,3.0])

# sets the PIC Time sync boolean
_cd.TimeStepSettings.PICTimeSync = False

# sets the irradiation time for radiation hardening sims
_cd.SwitchChargingOptions.SimulationType = ChargingEnvironment.Radiation
_cd.TimeStepSettings.IrradiationTime = 1e-6

Reference

ema3d.Api.V26.Charging.Domain Namespace