CSPropExcitation

class CSXCAD.CSProperties.CSPropExcitation

Bases: CSProperties

Excitation property

An excitation property is defined to define the (field) sources.

Depending on the EM modeling tool there exist different excitation types with different meanings.

Parameters:

• exc_type – int – excitation type (see SetExcitation)

• exc_val – (3,) array like – set the excitation vector

• delay – float – excitation delay in seconds

GetDelay()

GetExcitType()

Get the excitation type.

Returns:

int – excitation type (see above)

GetExcitation()

Returns:

(3,) array – excitation vector

GetFrequency()

GetPropagationDir()

Get the propagation direction, e.g. of a plane wave excitation

Returns:

(3,) array – propagation vector

GetWeightFunction()

Get the weigthing function for the excitation.

Returns:

3 element list of strings

SetDelay(val)

Set signal delay for this property.

Parameters:

val – float – Signal delay

SetExcitType(val)

Parameters:

val – int – excitation type (see above)

SetExcitation(val)

openEMS excitation types:

• 0 : E-field soft excitation

• 1 : E-field hard excitation

• 2 : H-field soft excitation

• 3 : H-field hard excitation

• 10 : plane wave excitation

Parameters:

val – (3,) array – excitation vector

SetFrequency(val)

Frequency for numerical phase velocity compensation (optional)

Parameters:

val – float – Frequency

SetPropagationDir(val)

Set the propagation direction, e.g. for a plane wave excitation

Parameters:

val – (3,) array – propagation vector

SetWeightFunction(func)

Set the weigthing function for the excitation.