MathScript

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])

    -- Create a math script
    
farFieldMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.FarField)
script = 
[[
dataSet = pf.FarField.GetDataSet("startup.StandardConfiguration1.FarFields", 51)
scale = 2
for freqIndex = 1, #dataSet.Axes["Frequency"] do
    for thetaIndex = 1, #dataSet.Axes["Theta"] do
        for phiIndex = 1, #dataSet.Axes["Phi"] do
            indexedValue = dataSet[freqIndex][thetaIndex][phiIndex]
            indexedValue.EFieldTheta = indexedValue.EFieldTheta * scale
            indexedValue.EFieldPhi = indexedValue.EFieldPhi * scale            
        end
    end
end
return dataSet
]]
farFieldMathScript.Script = script
    
    -- Run the math script

farFieldMathScript:Run()

    -- Plot the math script

farFieldPlot = app.Views[1].Plots:Add(farFieldMathScript)

Inheritance

The MathScript object is derived from the ResultData object.

The following objects are derived (specialisations) from the MathScript object:

• CustomMathScript
• ExcitationMathScript
• FarFieldMathScript
• LoadMathScript
• NearFieldMathScript
• NetworkMathScript
• PowerMathScript
• SParameterMathScript
• SurfaceCurrentsMathScript
• TRCoefficientMathScript
• WireCurrentsMathScript

Usage locations

The MathScript object can be accessed from the following locations:

• Methods
  • WireCurrentsMathScript object has method Duplicate().
  • SurfaceCurrentsMathScript object has method Duplicate().
  • CustomMathScript object has method Duplicate().
  • TRCoefficientMathScript object has method Duplicate().
  • PowerMathScript object has method Duplicate().
  • SParameterMathScript object has method Duplicate().
  • NetworkMathScript object has method Duplicate().
  • LoadMathScript object has method Duplicate().
  • ExcitationMathScript object has method Duplicate().
  • FarFieldMathScript object has method Duplicate().
  • NearFieldMathScript object has method Duplicate().
  • MathScript object has method Duplicate().
  • MathScriptCollection collection has method Items().
  • MathScriptCollection collection has method Item(number).
  • MathScriptCollection collection has method Item(string).
  • MathScriptCollection collection has method Add(MathScriptTypeEnum).

Property List

Label

The object label. (Read/Write string)

Script

The script code to execute. (Read/Write string)

Method List

Delete ()

Delete the math script.

Duplicate ()

Duplicate the math script. (Returns a MathScript object.)

Run ()

Run the math script.

Property Details

Label

The object label.

Type

string

Access

Read/Write

Script

The script code to execute.

Type

string

Access

Read/Write

Method Details

Delete ()

Delete the math script.

Duplicate ()

Duplicate the math script.

Return

MathScript

The duplicated math script.

Run ()

Run the math script.