SurfaceChargingMatDefn Class

An Surface charging Material Definition for the API.

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseSurfaceChargingMatDefn
    ema3d.Api.V25.Core.DefinitionsDefinitionBaseSurfaceChargingMatDefn
      ema3d.Api.V25.Charging.DefinitionsChargingMaterialBaseSurfaceChargingMatDefn
        ema3d.Api.V25.Charging.DefinitionsSurfaceChargingMatDefn

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

Syntax

C++

Copy

public class SurfaceChargingMatDefn : ChargingMaterialBase<SurfaceChargingMatDefn>

Public Class SurfaceChargingMatDefn
	Inherits ChargingMaterialBase(Of SurfaceChargingMatDefn)

public ref class SurfaceChargingMatDefn : public ChargingMaterialBase<SurfaceChargingMatDefn^>

type SurfaceChargingMatDefn = 
    class
        inherit ChargingMaterialBase<SurfaceChargingMatDefn>
    end

The SurfaceChargingMatDefn type exposes the following members.

Properties

	Name	Description
	AtomicMass	Gets/Sets the average atomic mass of the material. (Inherited from ChargingMaterialBaseT)
	AtomicNumber	Gets/Sets the average atomic number of the material. (Inherited from ChargingMaterialBaseT)
	Breakdown	Gets/Sets the dielectric breakdown strength of the material. (Inherited from ChargingMaterialBaseT)
	DeltaMaxInternal	Gets/Sets the internal delta max of the material. (Inherited from ChargingMaterialBaseT)
	Density	Gets/Sets density of the bulk material. (Inherited from ChargingMaterialBaseT)
	DisplayColor	Gets / Sets the definition display color. (Inherited from DefinitionBaseT)
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from DefinitionBaseT)
	Epsilon	Gets/Sets permittivity of isotropic material. (Inherited from ChargingMaterialBaseT)
	EpsilonRelative	Gets/Sets the relative dielectric constant (Inherited from ChargingMaterialBaseT)
	IsPSourceIncluded	Gets/Sets if the particle source should be included in the material properties. (Inherited from ChargingMaterialBaseT)
	Mu	Gets/Sets permeability of isotropic material. (Inherited from ChargingMaterialBaseT)
	Phtotoemission	Gets/Sets photoemission due to photoelectric effect. (Inherited from ChargingMaterialBaseT)
	RIC	Gets/Sets Radiation Induced Conductivity. (Inherited from ChargingMaterialBaseT)
	Sigma	Gets/Sets conductivity of isotropic material. (Inherited from ChargingMaterialBaseT)
	SigmaM	Gets/Sets magnetic conductivity of isotropic material. (Inherited from ChargingMaterialBaseT)
	SurfaceResistivity	Gets/Sets surface Resistivity of the material. (Inherited from ChargingMaterialBaseT)
	Thickness	Gets/Sets thickness of isotropic material (only for composite materials). (Inherited from ChargingMaterialBaseT)
	TriboCurrent	Gets/Sets triboelectric current source. (Inherited from ChargingMaterialBaseT)

Top

Methods

	Name	Description
	AssignBulk	Assign a material definition to a collection of document objects. (Inherited from DefinitionBaseT)
	AssignSingle	Assign a material definition to a single document object. (Inherited from DefinitionBaseT)
	Copy	Copy this definition to the same or a new document
	Create	Create a new default SurfaceChargindMatDefn within the document
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all SurfaceChargingMatDefn objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Charging.Definitions import SurfaceChargingMatDefn as SurfaceChargingMatDefn
# Create definition and modify properties
_smat = SurfaceChargingMatDefn.Create(Window.ActiveWindow.Document)
_smat.EpsilonRelative = 1.8
_smat.Sigma = 1e4

Reference

ema3d.Api.V25.Charging.Definitions Namespace