Home
Scripts and Application Programming Interface (API)
CADFEKO and POSTFEKO have a powerful, fast, lightweight scripting language integrated into the application allowing you to create models, get hold of simulation results and model configuration information as well as manipulation of data and automate repetitive tasks.
Script Types
There are two types of scripts that are supported in Feko, API scripts and result scripts. POSTFEKO supports both types of scripts, while CADFEKO only supports API scripts. It is important to use the correct script type in POSTFEKO to ensure that the desired result is achieved.
Result Script
A result script (math script), perform actions similar to general scripts, but the script returns a result object for displaying on graphs and the 3D view in POSTFEKO.
Structure of a DataSet
In order to modify or generate a DataSet, it is important to understand how they are constructed.
Axes
An axis is a dimension which data is calculated along. Typically an axes contain the set of physical points where data is calculated, the frequency or position where the data is calculated. A full list is given in topics/feko/user_guide/scripting/dataset_axes_feko_c.html#concept_d51_b3y_ncb__table_aqn_xb1_ybb. Any of these axes may be added to a DataSet.

Welcome
Release Notes
See what's new in the latest release.
Get Started
The Feko Getting Started Guide contains step-by-step instructions on how to get started with Feko.
Examples
The Feko Example Guide contains a collection of examples that teaches you Feko concepts and essentials.
Introduction to Feko
Feko is a comprehensive electromagnetic solver with multiple solution methods that is used for electromagnetic field analyses involving 3D objects of arbitrary shapes.
CADFEKO
CADFEKO is used to create and mesh the geometry or model mesh, specify the solution settings and calculation requests in a graphical environment.
POSTFEKO
POSTFEKO, the Feko post processor, is used to display the model (configuration and mesh), results on graphs and 3D views.
EDITFEKO
EDITFEKO is used to construct advanced models (both the geometry and solution requirements) using a high-level scripting language which includes loops and conditional statements.
Feko Solution Methods
One of the key features in Feko is that it includes a broad set of unique and hybridised solution methods. Effective use of Feko features requires an understanding of the available methods.
Optimisation in Feko
Feko offers state-of-the-art optimisation engines based on generic algorithm (GA) and other methods, which can be used to automatically optimise the design and determine the optimum solution.
Feko Utilities
The Feko utilities consist of PREFEKO, OPTFEKO, ADAPTFEKO, the Launcher utility, Updater and the crash reporter.
Description of the Output File of Feko
Feko writes all the results to an ASCII output file .out as well as a binary output file .bof for usage by POSTFEKO. Use the .out file to obtain additional information about the solution.
Feko Application Macros
A large collection of application macros are available for CADFEKO and POSTFEKO.
Scripts and Application Programming Interface (API)
CADFEKO and POSTFEKO have a powerful, fast, lightweight scripting language integrated into the application allowing you to create models, get hold of simulation results and model configuration information as well as manipulation of data and automate repetitive tasks.
- Introduction to Scripting and the API
  The scripting language that has been integrated with CADFEKO and POSTFEKO is called Lua. Lua has a syntax that is similar to Python and Matlab (or Octave) and is easy to learn and use.
- Script Editor
  The script editor allows you to create scripts based on the Lua language to control CADFEKO, POSTFEKO and other applications as well as manipulation of data to be viewed and analysed further in POSTFEKO.
- Macro Recording
  Use macro recording to record actions in a script. Play the script back to automate the process or view the script to learn the Lua-based scripting language by example. Macro recording allows you to perform repetitive actions faster and with less effort.
- Scripting Basics
  The scripting capability is powerful and help your work to be completed faster, but you first need to learn the basics of Lua and scripting in Feko.
- Script Types
  There are two types of scripts that are supported in Feko, API scripts and result scripts. POSTFEKO supports both types of scripts, while CADFEKO only supports API scripts. It is important to use the correct script type in POSTFEKO to ensure that the desired result is achieved.
  - General Scripts
    General or API scripts, are stored outside the POSTFEKO session and CADFEKO model as.lua files. These scripts are used by math scripts, but do not return data for visualisation. The script executes methods for controlling POSTFEKO or CADFEKO, for example, exporting all views as images, launching other applications, and reading and writing data to disk. Almost every aspect of POSTFEKO and CADFEKO is accessed and controlled using the API. A detailed description of the API objects, collections, enumerations, data types, predefined constants, methods and properties are available in the sections that follow.
  - Result Script
    A result script (math script), perform actions similar to general scripts, but the script returns a result object for displaying on graphs and the 3D view in POSTFEKO.
    - Pulling Data Into the Math Scripting Environment
      A common use for the scripting functionality is to modify existing POSTFEKO results.
    - Structure of a DataSet
      In order to modify or generate a DataSet, it is important to understand how they are constructed.
      - Axes
        An axis is a dimension which data is calculated along. Typically an axes contain the set of physical points where data is calculated, the frequency or position where the data is calculated. A full list is given in topics/feko/user_guide/scripting/dataset_axes_feko_c.html#concept_d51_b3y_ncb__table_aqn_xb1_ybb. Any of these axes may be added to a DataSet.
      - Quantities
        A quantity is a value that is calculated at each point for each axis in a DataSet. More than one quantity can be calculated for any position on the axes and each one typically represents a different type or component of a result.
      - MetaData
        In addition to Axes and Quantities, it may be required to provide additional information about a DataSet.
    - Processing and Modifying a DataSet
      A typical use for the scripting functionality is to modify existing results.
    - Index of Single Element in a DataSet
      This type of scheme is used when fine control is required when accessing a DataSet. It is also the most intuitive method of accessing the elements.
    - Iterate Through Elements in a DataSet
      For the individual element style of indexing, it is necessary to manually iterate over each element. A method to iterate over an unknown number of axes is presented, it is a powerful tool and simpler to maintain than nested loops.
    - Creating a Custom DataSet
      Another use for scripting is when custom data objects are required.
- Custom Dialogs (Forms)
  During the execution of an automation script, custom dialogs can be used that allows the script to be more interactive. When used in conjunction with the custom command library, it is possible to extend the user interface for a variety of custom workflows.
- Application Macros
  An application macro is a reference to an automation script, an icon file and associated metadata.
- Application Macro Library
  The application macro library allows commonly used application macros to be stored in a repository.
- Command Line Arguments for Launching Script
  A script can be run via the command line.
Appendix
Reference information is provided in the appendix.

Axes

An axis is a dimension which data is calculated along. Typically an axes contain the set of physical points where data is calculated, the frequency or position where the data is calculated. A full list is given in Table 1. Any of these axes may be added to a DataSet.

As an example, we pull in a near field from a horn antenna and print out the different axes.

Note: That the near field specifies three spatial dimensions and a frequency dimension.

nf = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearField1")
for index, axis in pairs(nf.Axes) do 
  print(string.format("axis[%d]: %s axis with %d values [%E to %E] %s",
                            index,
                            axis.Name, 
                            axis.Count, 
                            axis.Values[1], 
                            axis.Values[#axis.Values], 
                            axis.Unit))
end

axis[1]: Frequency axis with 1 values [1.645000E+009 to 1.645000E+009] Hz
axis[2]: X axis with 21 values [-2.600000E-001 to 2.600000E-001] m
axis[3]: Y axis with 21 values [-2.000000E-001 to 2.000000E-001] m
axis[4]: Z axis with 1 values [4.600000E-001 to 4.600000E-001] m

Analysing the example, one can see that the near field was calculated at a single frequency and at a single height. The other two spatial dimensions form a rectangle, making it clear that the near field is a flat surface at a fixed height and frequency. Each axis also indicates the unit in which the axis is measured. The spatial axes are measured in metre (m), while the frequency axis is measured in Hertz (Hz).

Note: That the data type for all of the axes are scalar. In other words, all of the axis values in this instance contain real values.

Table 1. Axis types for the Axes field
Axis type	Axes field
Position	X
	Y
	Z
	Theta
	Phi
	Rho
	R
Frequency axis	Frequency
Other axes	Arbitrary
	Index
	MediumNames
	PortNumber
	Solution
	S-parameter
	Undefined
	Time