GetFieldsCalculatorExpressions

Returns a list of named expressions available in the Fields Calculator window. The list will vary according to the active design.

UI Access In the Project Manager tree, right click Field Overlays, and select Calculator
Parameters
Name Type Description
<fieldType> String Optional; the available options will be determined by the active design. For all designs, the default is "Fields".
Return Value A list of strings containing named expressions for the specified fieldType. If the user does not provide a fieldType, all named expressions are returned, including user-defined expressions. Each entry in the list follows the format: "Name = expression".

 

Python Syntax GetFieldsCalculatorExpressions(<fieldType>)
Python Example

oModule = oDesign.GetModule("FieldsReporter")

namedExpressions = oModule.GetFieldsCalculatorExpressions()

Example of return value for a Maxwell Transient design when fieldType is “Fields”:

['Mag_H = Mag(Smooth(<Hx,Hy,Hz>))', 'Mag_B = Mag(Smooth(<Bx,By,Bz>))', 'Mag_J = Mag(Smooth(<Jx,Jy,Jz>))', 'H_Vector = Smooth(<Hx,Hy,Hz>)', 'B_Vector = Smooth(<Bx,By,Bz>)', 'J_Vector = Smooth(<Jx,Jy,Jz>)', 'energy = Smooth(Energy)', 'coEnergy = Smooth(CoEnergy)', 'appEnergy = Smooth(App_Energy)', 'Ohmic_Loss = Smooth(Ohmic-Loss)', 'Total_Loss = Smooth(TotalLoss)', 'Temperature = Smooth(Temp)', 'Volume_Force_Density = <VolumeForceDensityx,VolumeForceDensityy,VolumeForceDensityz>', 'Surface_Force_Density = <SurfaceForceDensityx,SurfaceForceDensityy,SurfaceForceDensityz>', 'Demag_Coef = Smooth(DemagCoef)', 'Surface_Loss_Density = SurfaceLossDensity']