PICOptions Class

An object implementing the PIC Options in Charge Domain.

Inheritance Hierarchy

SystemObject
ema3d.Api.V26.Charging.DomainPICOptions

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 PICOptions

Public NotInheritable Class PICOptions

public ref class PICOptions sealed

[<SealedAttribute>]
type PICOptions = class end

The PICOptions type exposes the following members.

Properties

	Name	Description
	AverageIterations	Average iterations for the PIC.
	BackgroundBField	Background B-Field x,y,z applied to particles.
	BackgroundEField	Background E-Field x,y,z applied to particles.
	BiasVelocity	BiasVelocity x,y,z applied to particles.
	DiffuseSpecularFraction	Fraction of particles that scatter diffusely. Remaining particles scatter specularly. 1 being fully diffuse. 0 being specular.
	MaxIterations	Max number of the PIC iterations.
	PICEMModel	PIC EM Model: Space Charge, Conductivity, or Null dropdown.
	PICScattering	When enabled, PIC Scattering Type: Specular, Mixed, Diffuse.
	StatisticalMeasure	The number of total macroparticles the PIC solver will track.

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 does not directly wrap the various solver and flux classes, but instead implements some of the wrapped properties of these classes to be used in Charge Domain. Corresponds to the PIC Options displayed in the UI.

Example

Python

Copy

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

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

pic = _cd.PICOptions

pic.StatisticalMeasure = 1000000
pic.MaxIterations = 25
pic.AverageIterations = 1
pic.PICEMModel = PICSourceType.SpaceCharge

pic.BackgroundEField = [0.0, 0.0, 0.0]
pic.BackgroundBField = [0.0, 0.0, 0.0]
pic.BiasVelocity = [0.0, 0.0, 0.0]

Reference

ema3d.Api.V26.Charging.Domain Namespace