Background Class

A wrapped FDTD Background object attached to a Domain.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25.Core.DomainDomainChildBaseBackground
ema3d.Api.V25.Core.DomainBackground

Namespace: ema3d.Api.V25.Core.Domain
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class Background : DomainChildBase<Background>

Public NotInheritable Class Background
	Inherits DomainChildBase(Of Background)

public ref class Background sealed : public DomainChildBase<Background^>

[<SealedAttribute>]
type Background = 
    class
        inherit DomainChildBase<Background>
    end

The Background type exposes the following members.

Properties

	Name	Description
	AirDensity	Gets/Sets background air density of FDTD Domain
	BackgroundType	Gets/Sets type of background being used. (Linear or Nonlinear)
	Conductivity	Gets/Sets background conductivity of FDTD Domain
	MagneticConductivity	Gets/Sets background magnetic conductivity of FDTD Domain
	Permeability	Gets/Sets background permeability of FDTD Domain
	Permittivity	Gets/Sets background permittivity of FDTD Domain
	WaterContent	Gets/Sets background water content of FDTD Domain

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 FDTD Domain and cannot be created individually. Modifications to, and copies of, this object will operate on the single FDTD domain within the document.

Example

Python

Copy

from ema3d.Api.V25.Core.Domain import Domain as Domain
from ema3d.Api.V25.Core.Domain import BackgroundType as BackgroundType

# Get/Create Domain
_dom = Domain.GetInstance()
# Modify Background
_dom.Background.BackgroundType = BackgroundType.Nonlinear
_dom.Background.Conductivity = 1e-3

Reference

ema3d.Api.V25.Core.Domain Namespace